Implements a test case to evaluate the reception process of WiFi Physical Layer (PHY) frames (PPDU) with multiple MAC Protocol Data Units (MPDUs). More...

Inheritance diagram for TestWifiPhyRxTraceHelper:

Collaboration diagram for TestWifiPhyRxTraceHelper:

Public Member Functions
	TestWifiPhyRxTraceHelper (std::string test_name)
	Constructs a TestWifiPhyRxTraceHelper instance with a given test name.

	~TestWifiPhyRxTraceHelper () override=default
	Destructor.

Public Member Functions inherited from ns3::TestCase
	TestCase (const TestCase &)=delete

virtual	~TestCase ()
	Destructor.

std::string	GetName () const

TestCase &	operator= (const TestCase &)=delete

Private Member Functions
void	CheckAllStats (uint64_t expectedPpduSuccess, uint64_t expectedPpduFailure, uint64_t expectedMpduSuccess, uint64_t expectedMpduFailure, uint64_t expectedOverlaps, uint64_t expectedNonOverlaps)
	Checks the statistics of PPDU and MPDU reception success and failure.

void	CheckRecords (uint64_t expectedRecordCount)
	Checks the statistics of PPDU and MPDU reception success and failure.

void	CheckStats (WifiPhyTraceStatistics expectedStats, uint32_t nodeId, uint32_t deviceId, uint32_t linkId)
	Checks the statistics of PPDU and MPDU reception success and failure.

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	SendPpduWithOneMpdu (double rxPowerDbm, Mac48Address add1, Ptr< ns3::SpectrumWifiPhy > tx_phy)
	Sends a PPDU containing one MPDU addressed to a specific receiver.

void	SendPpduWithTwoMpdus (double rxPowerDbm, Mac48Address add1, Mac48Address add2, Ptr< ns3::SpectrumWifiPhy > tx_phy)
	Sends a PPDU containing two MPDUs addressed to specific receivers.

Private Attributes
Mac48Address	correctReceiver
	The MAC address representing the correct receiver, used for testing.

Ptr< SpectrumWifiPhy >	m_rx {nullptr}
	The receive function for testing.

WifiPhyRxTraceHelper	m_rxTraceHelper
	The helper being tested for tracking PHY reception events.

Ptr< SpectrumWifiPhy >	m_txA {nullptr}
	The transmit function for node A.

Ptr< SpectrumWifiPhy >	m_txB {nullptr}
	The transmit function for node B.

std::map< ns3::Mac48Address, uint32_t >	MacToNodeId
	Maps MAC addresses to node IDs.

Ptr< Node >	nodeRx
	The receiving node.

Mac48Address	wrongReceiver
	The MAC address representing an incorrect receiver, used for testing.

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.

TestCase *	GetParent () 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

Implements a test case to evaluate the reception process of WiFi Physical Layer (PHY) frames (PPDU) with multiple MAC Protocol Data Units (MPDUs).

This class extends the TestCase class to simulate and analyze the reception of PPDUs containing either one or two MPDUs. It specifically tests the PHY layer's capability to handle multiple MPDUs addressed to specific receivers, measuring success and failure rates. The simulation setup includes configuring transmit and receive power levels, and the class provides functionality to check statistics related to PPDU and MPDU reception success and failure, as well as overlap handling.

Definition at line 66 of file wifi-phy-rx-trace-helper-test.cc.

Constructor & Destructor Documentation

◆ TestWifiPhyRxTraceHelper()

TestWifiPhyRxTraceHelper::TestWifiPhyRxTraceHelper ( std::string test_name )

Constructs a TestWifiPhyRxTraceHelper instance with a given test name.

Parameters

test_name The name of the test case.

Definition at line 165 of file wifi-phy-rx-trace-helper-test.cc.

◆ ~TestWifiPhyRxTraceHelper()

TestWifiPhyRxTraceHelper::~TestWifiPhyRxTraceHelper ( )

overridedefault

Destructor.

Member Function Documentation

◆ CheckAllStats()

void TestWifiPhyRxTraceHelper::CheckAllStats	(	uint64_t	expectedPpduSuccess,
		uint64_t	expectedPpduFailure,
		uint64_t	expectedMpduSuccess,
		uint64_t	expectedMpduFailure,
		uint64_t	expectedOverlaps,
		uint64_t	expectedNonOverlaps )

private

Checks the statistics of PPDU and MPDU reception success and failure.

Parameters

expectedPpduSuccess	The expected number of successful PPDU receptions.
expectedPpduFailure	The expected number of failed PPDU receptions.
expectedMpduSuccess	The expected number of successful MPDU receptions within PPDUs.
expectedMpduFailure	The expected number of failed MPDU receptions within PPDUs.
expectedOverlaps	The expected number of overlapping reception events.
expectedNonOverlaps	The expected number of non-overlapping reception events.

Definition at line 325 of file wifi-phy-rx-trace-helper-test.cc.

References ns3::WifiPhyRxTraceHelper::GetStatistics(), ns3::WifiPhyTraceStatistics::m_failedMpdus, ns3::WifiPhyTraceStatistics::m_failedPpdus, ns3::WifiPhyTraceStatistics::m_nonOverlappingPpdus, ns3::WifiPhyTraceStatistics::m_overlappingPpdus, ns3::WifiPhyTraceStatistics::m_receivedMpdus, ns3::WifiPhyTraceStatistics::m_receivedPpdus, m_rxTraceHelper, NS_TEST_ASSERT_MSG_EQ, and ns3::WifiPhyRxTraceHelper::Reset().

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckRecords()

void TestWifiPhyRxTraceHelper::CheckRecords ( uint64_t expectedRecordCount )

private

Checks the statistics of PPDU and MPDU reception success and failure.

Parameters

expectedRecordCount The expected number of records.

Definition at line 384 of file wifi-phy-rx-trace-helper-test.cc.

References ns3::WifiPhyRxTraceHelper::GetPpduRecords(), m_rxTraceHelper, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckStats()

void TestWifiPhyRxTraceHelper::CheckStats	(	WifiPhyTraceStatistics	expectedStats,
		uint32_t	nodeId,
		uint32_t	deviceId,
		uint32_t	linkId )

private

Checks the statistics of PPDU and MPDU reception success and failure.

Parameters

expectedStats	The expected counts for PPDU and MPDU reception.
nodeId	The node ID for which to check the received stats.
deviceId	The device ID for which to check the received stats.
linkId	The link ID for which to check the received stats.

Definition at line 356 of file wifi-phy-rx-trace-helper-test.cc.

References ns3::WifiPhyRxTraceHelper::GetStatistics(), ns3::WifiPhyTraceStatistics::m_failedMpdus, ns3::WifiPhyTraceStatistics::m_failedPpdus, ns3::WifiPhyTraceStatistics::m_nonOverlappingPpdus, ns3::WifiPhyTraceStatistics::m_overlappingPpdus, ns3::WifiPhyTraceStatistics::m_receivedMpdus, ns3::WifiPhyTraceStatistics::m_receivedPpdus, m_rxTraceHelper, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoRun()

void TestWifiPhyRxTraceHelper::DoRun ( )

overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 393 of file wifi-phy-rx-trace-helper-test.cc.

References CheckAllStats(), CheckRecords(), CheckStats(), correctReceiver, ns3::Simulator::Destroy(), ns3::Node::GetId(), ns3::WifiPhyTraceStatistics::m_failedMpdus, ns3::WifiPhyTraceStatistics::m_failedPpdus, ns3::WifiPhyTraceStatistics::m_nonOverlappingPpdus, ns3::WifiPhyTraceStatistics::m_overlappingPpdus, ns3::WifiPhyTraceStatistics::m_receivedMpdus, ns3::WifiPhyTraceStatistics::m_receivedPpdus, m_rx, m_rxTraceHelper, m_txA, m_txB, ns3::MicroSeconds(), nodeRx, ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), SendPpduWithOneMpdu(), SendPpduWithTwoMpdus(), ns3::RngSeedManager::SetRun(), ns3::RngSeedManager::SetSeed(), ns3::WifiPhyRxTraceHelper::Start(), ns3::WifiPhyRxTraceHelper::Stop(), and wrongReceiver.

Here is the call graph for this function:

◆ DoSetup()

void TestWifiPhyRxTraceHelper::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 171 of file wifi-phy-rx-trace-helper-test.cc.

References ns3::NodeContainer::Add(), ns3::Node::AddDevice(), ns3::CreateObject(), ns3::WifiPhyRxTraceHelper::Enable(), m_rx, m_rxTraceHelper, m_txA, m_txB, MacToNodeId, nodeRx, nodes, ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_STANDARD_80211ax.

Here is the call graph for this function:

◆ DoTeardown()

void TestWifiPhyRxTraceHelper::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 244 of file wifi-phy-rx-trace-helper-test.cc.

References m_rx, m_txA, and m_txB.

◆ SendPpduWithOneMpdu()

void TestWifiPhyRxTraceHelper::SendPpduWithOneMpdu	(	double	rxPowerDbm,
		Mac48Address	add1,
		Ptr< ns3::SpectrumWifiPhy >	tx_phy )

private

Sends a PPDU containing one MPDU addressed to a specific receiver.

Parameters

rxPowerDbm	The transmit power in dBm.
add1	The MAC address of the receiver.
tx_phy	The transmitting PHY object.

Definition at line 293 of file wifi-phy-rx-trace-helper-test.cc.

References ns3::Create(), ns3::HePhy::GetHeMcs0(), ns3::NanoSeconds(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_QOSDATA, and ns3::WIFI_PREAMBLE_HE_SU.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendPpduWithTwoMpdus()

void TestWifiPhyRxTraceHelper::SendPpduWithTwoMpdus	(	double	rxPowerDbm,
		Mac48Address	add1,
		Mac48Address	add2,
		Ptr< ns3::SpectrumWifiPhy >	tx_phy )

private

Sends a PPDU containing two MPDUs addressed to specific receivers.

Parameters

rxPowerDbm	The transmit power in dBm.
add1	The MAC address of the first receiver.
add2	The MAC address of the second receiver.
tx_phy	The transmitting PHY object.

Definition at line 252 of file wifi-phy-rx-trace-helper-test.cc.

References ns3::Create(), ns3::HePhy::GetHeMcs0(), ns3::NanoSeconds(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_QOSDATA, and ns3::WIFI_PREAMBLE_HE_SU.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ correctReceiver

Mac48Address TestWifiPhyRxTraceHelper::correctReceiver

private

Initial value:

=

Mac48Address("00:00:00:00:00:03")

The MAC address representing the correct receiver, used for testing.

Definition at line 144 of file wifi-phy-rx-trace-helper-test.cc.

Referenced by DoRun().

◆ m_rx

Ptr<SpectrumWifiPhy> TestWifiPhyRxTraceHelper::m_rx {nullptr}

private

The receive function for testing.

Definition at line 159 of file wifi-phy-rx-trace-helper-test.cc.

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

◆ m_rxTraceHelper

WifiPhyRxTraceHelper TestWifiPhyRxTraceHelper::m_rxTraceHelper

private

The helper being tested for tracking PHY reception events.

Definition at line 162 of file wifi-phy-rx-trace-helper-test.cc.

Referenced by CheckAllStats(), CheckRecords(), CheckStats(), DoRun(), and DoSetup().

◆ m_txA

Ptr<SpectrumWifiPhy> TestWifiPhyRxTraceHelper::m_txA {nullptr}

private

The transmit function for node A.

Definition at line 157 of file wifi-phy-rx-trace-helper-test.cc.

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

◆ m_txB

Ptr<SpectrumWifiPhy> TestWifiPhyRxTraceHelper::m_txB {nullptr}

private

The transmit function for node B.

Definition at line 158 of file wifi-phy-rx-trace-helper-test.cc.

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

◆ MacToNodeId

std::map<ns3::Mac48Address, uint32_t> TestWifiPhyRxTraceHelper::MacToNodeId

private

Initial value:

= {
        {Mac48Address("00:00:00:00:00:04"), 0},
        {Mac48Address("00:00:00:00:00:05"), 1},
        {correctReceiver, 2},
        {wrongReceiver, 3}}

Maps MAC addresses to node IDs.

This is done since there is no MAC layer configured and therefore the helper cannot obtain the MAC addresses automatically.

Definition at line 148 of file wifi-phy-rx-trace-helper-test.cc.

Referenced by DoSetup().

◆ nodeRx

Ptr<Node> TestWifiPhyRxTraceHelper::nodeRx

private

The receiving node.

Definition at line 156 of file wifi-phy-rx-trace-helper-test.cc.

Referenced by DoRun(), and DoSetup().

◆ wrongReceiver

Mac48Address TestWifiPhyRxTraceHelper::wrongReceiver

private

Initial value:

=

Mac48Address("00:00:00:00:00:01")

The MAC address representing an incorrect receiver, used for testing.

Definition at line 141 of file wifi-phy-rx-trace-helper-test.cc.

Referenced by DoRun().

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

src/wifi/test/wifi-phy-rx-trace-helper-test.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TestWifiPhyRxTraceHelper()

◆ ~TestWifiPhyRxTraceHelper()

Member Function Documentation

◆ CheckAllStats()

◆ CheckRecords()

◆ CheckStats()

◆ DoRun()

◆ DoSetup()

◆ DoTeardown()

◆ SendPpduWithOneMpdu()

◆ SendPpduWithTwoMpdus()

Member Data Documentation

◆ correctReceiver

◆ m_rx

◆ m_rxTraceHelper

◆ m_txA

◆ m_txB

◆ MacToNodeId

◆ nodeRx

◆ wrongReceiver