A Discrete-Event Network Simulator
API
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ChannelAccessTestCase Class Reference

This test case tests channel access assignments which is done by StartSch and StopSch method of WaveNetDevice. More...

+ Inheritance diagram for ChannelAccessTestCase:
+ Collaboration diagram for ChannelAccessTestCase:

Public Member Functions

 ChannelAccessTestCase ()
 
 ~ChannelAccessTestCase () override
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName () const
 
TestCase & operator= (const TestCase &)=delete
 

Private Member Functions

void DoRun () override
 Implementation to actually run this TestCase. More...
 
bool Receive (Ptr< NetDevice > dev, Ptr< const Packet > pkt, uint16_t mode, const Address &sender)
 Receive function. More...
 
void SendX (uint32_t channel, uint32_t receiverId)
 Send X function. More...
 
void TestAlternating (SchInfo &info, bool shouldSucceed)
 Test aternating function. More...
 
void TestAlternatingAfter (uint32_t channelNumber, bool isAccessAssigned)
 Test alternating after function. More...
 
void TestContinuous (SchInfo &info, bool shouldSucceed)
 Test continuous function. More...
 
void TestContinuousAfter (uint32_t channelNumber, bool isAccessAssigned)
 Test continuous after function. More...
 
void TestExtended (SchInfo &info, bool shouldSucceed)
 Test extended function. More...
 
void TestExtendedAfter (uint32_t channelNumber, bool isAccessAssigned)
 Test extended after function. More...
 

Private Attributes

NetDeviceContainer m_devices
 the devices More...
 
uint32_t m_received
 received More...
 
Ptr< WaveNetDevice > m_sender
 sender More...
 

Additional Inherited Members

- Public Types inherited from ns3::TestCase
enum  TestDuration { QUICK = 1 , EXTENSIVE = 2 , TAKES_FOREVER = 3 }
 How long the test takes to execute. More...
 
- Protected Member Functions inherited from ns3::TestCase
 TestCase (std::string name)
 Constructor. More...
 
void AddTestCase (TestCase *testCase, TestDuration duration=QUICK)
 Add an individual child TestCase to this test suite. More...
 
TestCase * GetParent () const
 Get the parent of this TestCase. More...
 
bool IsStatusFailure () const
 Check if any tests failed. More...
 
bool IsStatusSuccess () const
 Check if all tests passed. More...
 
void SetDataDir (std::string directory)
 Set the data directory where reference trace files can be found. More...
 
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. More...
 
bool MustAssertOnFailure () const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure () const
 Check if this run should continue on failure. More...
 
std::string CreateDataDirFilename (std::string filename)
 Construct the full path to a file in the data directory. More...
 
std::string CreateTempDirFilename (std::string filename)
 Construct the full path to a file in a temporary directory. More...
 

Detailed Description

This test case tests channel access assignments which is done by StartSch and StopSch method of WaveNetDevice.

channel access assignments include ContinuousAccess, ExtendedAccess, and AlternatingAccess. The results of this test case depend on the implementation of ChannelScheduler In this case, the results depend on class "DefaultChannelScheduler".

Definition at line 754 of file mac-extension-test-suite.cc.

Constructor & Destructor Documentation

◆ ChannelAccessTestCase()

ChannelAccessTestCase::ChannelAccessTestCase ( )

Definition at line 821 of file mac-extension-test-suite.cc.

◆ ~ChannelAccessTestCase()

ChannelAccessTestCase::~ChannelAccessTestCase ( )
override

Definition at line 826 of file mac-extension-test-suite.cc.

Member Function Documentation

◆ DoRun()

void ChannelAccessTestCase::DoRun ( )
overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 953 of file mac-extension-test-suite.cc.

References CCH, third::channel, TestCaseHelper::CreatWaveDevice(), EXTENDED_ALTERNATING, EXTENDED_CONTINUOUS, ns3::NetDeviceContainer::Get(), m_devices, m_received, m_sender, ns3::MakeCallback(), NS_TEST_EXPECT_MSG_EQ, Receive(), SCH1, SCH2, SCH3, SCH4, SCH5, SCH6, ns3::Seconds(), SendX(), ns3::WaveNetDevice::SetReceiveCallback(), TestAlternating(), TestAlternatingAfter(), TestContinuous(), TestContinuousAfter(), TestExtended(), and TestExtendedAfter().

+ Here is the call graph for this function:

◆ Receive()

bool ChannelAccessTestCase::Receive ( Ptr< NetDevice >  dev,
Ptr< const Packet >  pkt,
uint16_t  mode,
const Address &  sender 
)
private

Receive function.

Parameters
devthe device
pktthe packet
modethe mode
senderthe sender address
Returns
true if successful

Definition at line 909 of file mac-extension-test-suite.cc.

References ns3::Packet::CopyData(), data, ns3::Packet::GetSize(), m_received, and NS_TEST_EXPECT_MSG_EQ.

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SendX()

void ChannelAccessTestCase::SendX ( uint32_t  channel,
uint32_t  receiverId 
)
private

Send X function.

Parameters
channelthe channel number
receiverId

Definition at line 879 of file mac-extension-test-suite.cc.

References third::channel, data, ns3::Time::GetTimeStep(), m_sender, ns3::Now(), and ns3::WaveNetDevice::SendX().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ TestAlternating()

void ChannelAccessTestCase::TestAlternating ( SchInfo &  info,
bool  shouldSucceed 
)
private

Test aternating function.

Parameters
infothe schedule info
shouldSucceedtrue if it should succeed

Definition at line 863 of file mac-extension-test-suite.cc.

References m_sender, ns3::Now(), NS_TEST_EXPECT_MSG_EQ, and ns3::WaveNetDevice::StartSch().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ TestAlternatingAfter()

void ChannelAccessTestCase::TestAlternatingAfter ( uint32_t  channelNumber,
bool  isAccessAssigned 
)
private

Test alternating after function.

Parameters
channelNumberthe channel number
isAccessAssignedtrue if access assigned

Definition at line 870 of file mac-extension-test-suite.cc.

References ns3::WaveNetDevice::GetChannelScheduler(), m_sender, ns3::Now(), and NS_TEST_EXPECT_MSG_EQ.

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ TestContinuous()

void ChannelAccessTestCase::TestContinuous ( SchInfo &  info,
bool  shouldSucceed 
)
private

Test continuous function.

Parameters
infothe schedule info
shouldSucceedtrue if it should succeed

Definition at line 831 of file mac-extension-test-suite.cc.

References m_sender, ns3::Now(), NS_TEST_EXPECT_MSG_EQ, and ns3::WaveNetDevice::StartSch().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ TestContinuousAfter()

void ChannelAccessTestCase::TestContinuousAfter ( uint32_t  channelNumber,
bool  isAccessAssigned 
)
private

Test continuous after function.

Parameters
channelNumberthe channel number
isAccessAssignedtrue if access assigned

Definition at line 838 of file mac-extension-test-suite.cc.

References ns3::WaveNetDevice::GetChannelScheduler(), m_sender, ns3::Now(), and NS_TEST_EXPECT_MSG_EQ.

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ TestExtended()

void ChannelAccessTestCase::TestExtended ( SchInfo &  info,
bool  shouldSucceed 
)
private

Test extended function.

Parameters
infothe schedule info
shouldSucceedtrue if it should succeed

Definition at line 847 of file mac-extension-test-suite.cc.

References m_sender, ns3::Now(), NS_TEST_EXPECT_MSG_EQ, and ns3::WaveNetDevice::StartSch().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ TestExtendedAfter()

void ChannelAccessTestCase::TestExtendedAfter ( uint32_t  channelNumber,
bool  isAccessAssigned 
)
private

Test extended after function.

Parameters
channelNumberthe channel number
isAccessAssignedtrue if access assigned

Definition at line 854 of file mac-extension-test-suite.cc.

References ns3::WaveNetDevice::GetChannelScheduler(), m_sender, ns3::Now(), and NS_TEST_EXPECT_MSG_EQ.

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_devices

NetDeviceContainer ChannelAccessTestCase::m_devices
private

the devices

Definition at line 816 of file mac-extension-test-suite.cc.

Referenced by DoRun().

◆ m_received

uint32_t ChannelAccessTestCase::m_received
private

received

Definition at line 818 of file mac-extension-test-suite.cc.

Referenced by DoRun(), and Receive().

◆ m_sender

Ptr<WaveNetDevice> ChannelAccessTestCase::m_sender
private

sender

Definition at line 817 of file mac-extension-test-suite.cc.

Referenced by DoRun(), SendX(), TestAlternating(), TestAlternatingAfter(), TestContinuous(), TestContinuousAfter(), TestExtended(), and TestExtendedAfter().

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