A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
PhyChannelSettingsToOperatingChannelTest Class Reference

Test the conversion from PHY ChannelSettings attribute to WifiPhyOperatingChannel. More...

+ Inheritance diagram for PhyChannelSettingsToOperatingChannelTest:
+ Collaboration diagram for PhyChannelSettingsToOperatingChannelTest:

Public Member Functions

 PhyChannelSettingsToOperatingChannelTest ()
 Constructor.
 
 ~PhyChannelSettingsToOperatingChannelTest () override=default
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor.
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

void DoRun () override
 Implementation to actually run this TestCase.
 
void DoSetup () override
 Implementation to do any local setup required for this TestCase.
 
void DoTeardown () override
 Implementation to do any local setup required for this TestCase.
 
void RunOne (const std::string &channelSettings, WifiChannelWidthType expectedWidthType, const std::vector< FrequencyChannelInfo > &expectedSegments, uint8_t expectedP20Index)
 Run one function.
 

Private Attributes

Ptr< SpectrumWifiPhym_phy
 the PHY
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum class  Duration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Static Public Attributes inherited from ns3::TestCase
static constexpr auto QUICK = Duration::QUICK
 Deprecated test duration simple enums.
 
static constexpr auto EXTENSIVE = Duration::EXTENSIVE
 
static constexpr auto TAKES_FOREVER = Duration::TAKES_FOREVER
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor.
 
void AddTestCase (TestCase *testCase, Duration duration=Duration::QUICK)
 Add an individual child TestCase to this test suite.
 
TestCaseGetParent () const
 Get the parent of this TestCase.
 
bool IsStatusFailure () const
 Check if any tests failed.
 
bool IsStatusSuccess () const
 Check if all tests passed.
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found.
 
void ReportTestFailure (std::string cond, std::string actual, std::string limit, std::string message, std::string file, int32_t line)
 Log the failure of this TestCase.
 
bool MustAssertOnFailure () const
 Check if this run should assert on failure.
 
bool MustContinueOnFailure () const
 Check if this run should continue on failure.
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory.
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory.
 

Detailed Description

Test the conversion from PHY ChannelSettings attribute to WifiPhyOperatingChannel.

Definition at line 224 of file wifi-operating-channel-test.cc.

Constructor & Destructor Documentation

◆ PhyChannelSettingsToOperatingChannelTest()

PhyChannelSettingsToOperatingChannelTest::PhyChannelSettingsToOperatingChannelTest ( )

Constructor.

Definition at line 253 of file wifi-operating-channel-test.cc.

◆ ~PhyChannelSettingsToOperatingChannelTest()

PhyChannelSettingsToOperatingChannelTest::~PhyChannelSettingsToOperatingChannelTest ( )
overridedefault

Member Function Documentation

◆ DoRun()

void PhyChannelSettingsToOperatingChannelTest::DoRun ( )
overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 350 of file wifi-operating-channel-test.cc.

References RunOne(), and ns3::WIFI_PHY_BAND_5GHZ.

+ Here is the call graph for this function:

◆ DoSetup()

void PhyChannelSettingsToOperatingChannelTest::DoSetup ( )
overrideprivatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test setup before DoRun is invoked.

Reimplemented from ns3::TestCase.

Definition at line 259 of file wifi-operating-channel-test.cc.

References ns3::CreateObject(), m_phy, and ns3::WIFI_STANDARD_80211ax.

+ Here is the call graph for this function:

◆ DoTeardown()

void PhyChannelSettingsToOperatingChannelTest::DoTeardown ( )
overrideprivatevirtual

Implementation to do any local setup required for this TestCase.

Subclasses should override this method to perform any costly per-test teardown

Reimplemented from ns3::TestCase.

Definition at line 277 of file wifi-operating-channel-test.cc.

References m_phy.

◆ RunOne()

void PhyChannelSettingsToOperatingChannelTest::RunOne ( const std::string & channelSettings,
WifiChannelWidthType expectedWidthType,
const std::vector< FrequencyChannelInfo > & expectedSegments,
uint8_t expectedP20Index )
private

Run one function.

Parameters
channelSettingsthe string to set the ChannelSettings attribute
expectedWidthTypethe expected width type of the operating channel
expectedSegmentsthe info about each expected segment of the operating channel
expectedP20Indexthe expected index of the P20

Definition at line 284 of file wifi-operating-channel-test.cc.

References m_phy, NS_LOG_FUNCTION, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_phy

Ptr<SpectrumWifiPhy> PhyChannelSettingsToOperatingChannelTest::m_phy
private

the PHY

Definition at line 250 of file wifi-operating-channel-test.cc.

Referenced by DoSetup(), DoTeardown(), and RunOne().


The documentation for this class was generated from the following file: