DL-OFDMA PHY puncturing test. More...

Inheritance diagram for TestDlOfdmaPhyPuncturing:

Collaboration diagram for TestDlOfdmaPhyPuncturing:

Public Member Functions
	TestDlOfdmaPhyPuncturing ()

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	CheckPhyState (Ptr< OfdmaSpectrumWifiPhy > phy, WifiPhyState expectedState)
	Schedule now to check the PHY state.

void	CheckResultsSta1 (uint32_t expectedRxSuccess, uint32_t expectedRxFailure, uint32_t expectedRxBytes)
	Check the results for STA 1.

void	CheckResultsSta2 (uint32_t expectedRxSuccess, uint32_t expectedRxFailure, uint32_t expectedRxBytes)
	Check the results for STA 2.

void	DoCheckPhyState (Ptr< OfdmaSpectrumWifiPhy > phy, WifiPhyState expectedState)
	Check the PHY state now.

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	GenerateInterference (Ptr< SpectrumValue > interferencePsd, Time duration)
	Generate interference function.

void	ResetResults ()
	Reset the results.

void	RunOne ()
	Run one function.

void	RxFailureSta1 (Ptr< const WifiPsdu > psdu)
	Receive failure function for STA 1.

void	RxFailureSta2 (Ptr< const WifiPsdu > psdu)
	Receive failure function for STA 2.

void	RxSuccessSta1 (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, const std::vector< bool > statusPerMpdu)
	Receive success function for STA 1.

void	RxSuccessSta2 (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, std::vector< bool > statusPerMpdu)
	Receive success function for STA 2.

void	SendMuPpdu (uint16_t rxStaId1, uint16_t rxStaId2, const std::vector< bool > &puncturedSubchannels)
	Send MU-PPDU function.

void	StopInterference ()
	Stop interference function.

Private Attributes
uint16_t	m_channelWidth
	channel width in MHz

uint32_t	m_countRxBytesSta1
	count RX bytes for STA 1

uint32_t	m_countRxBytesSta2
	count RX bytes for STA 2

uint32_t	m_countRxFailureSta1
	count RX failure for STA 1

uint32_t	m_countRxFailureSta2
	count RX failure for STA 2

uint32_t	m_countRxSuccessSta1
	count RX success for STA 1

uint32_t	m_countRxSuccessSta2
	count RX success for STA 2

Time	m_expectedPpduDuration20Mhz
	expected duration to send MU PPDU on 20 MHz RU

Time	m_expectedPpduDuration40Mhz
	expected duration to send MU PPDU on 40 MHz RU

uint16_t	m_frequency
	frequency in MHz

uint8_t	m_indexSubchannel
	Index of the subchannel (starting from 0) that should contain an interference and be punctured during the test run.

Ptr< SpectrumWifiPhy >	m_phyAp
	PHY of AP.

Ptr< WaveformGenerator >	m_phyInterferer
	PHY of interferer.

Ptr< OfdmaSpectrumWifiPhy >	m_phySta1
	PHY of STA 1.

Ptr< OfdmaSpectrumWifiPhy >	m_phySta2
	PHY of STA 2.

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...

using	instead = Duration

Static Public Attributes inherited from ns3::TestCase
static constexpr auto	EXTENSIVE = Duration::EXTENSIVE

static constexpr auto	QUICK = Duration::QUICK

static constexpr auto	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

DL-OFDMA PHY puncturing test.

Definition at line 1190 of file wifi-phy-ofdma-test.cc.

Constructor & Destructor Documentation

◆ TestDlOfdmaPhyPuncturing()

TestDlOfdmaPhyPuncturing::TestDlOfdmaPhyPuncturing ( )

Definition at line 1325 of file wifi-phy-ofdma-test.cc.

Member Function Documentation

◆ CheckPhyState()

void TestDlOfdmaPhyPuncturing::CheckPhyState	(	Ptr< OfdmaSpectrumWifiPhy >	phy,
		WifiPhyState	expectedState
	)

private

Schedule now to check the PHY state.

Parameters

phy	the PHY
expectedState	the expected state of the PHY

Definition at line 1519 of file wifi-phy-ofdma-test.cc.

References DoCheckPhyState(), and ns3::Simulator::ScheduleNow().

Referenced by RunOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckResultsSta1()

void TestDlOfdmaPhyPuncturing::CheckResultsSta1	(	uint32_t	expectedRxSuccess,
		uint32_t	expectedRxFailure,
		uint32_t	expectedRxBytes
	)

private

Check the results for STA 1.

Parameters

expectedRxSuccess	the expected number of RX success
expectedRxFailure	the expected number of RX failures
expectedRxBytes	the expected number of RX bytes

Definition at line 1487 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta1, m_countRxFailureSta1, m_countRxSuccessSta1, and NS_TEST_ASSERT_MSG_EQ.

Referenced by RunOne().

Here is the caller graph for this function:

◆ CheckResultsSta2()

void TestDlOfdmaPhyPuncturing::CheckResultsSta2	(	uint32_t	expectedRxSuccess,
		uint32_t	expectedRxFailure,
		uint32_t	expectedRxBytes
	)

private

Check the results for STA 2.

Parameters

expectedRxSuccess	the expected number of RX success
expectedRxFailure	the expected number of RX failures
expectedRxBytes	the expected number of RX bytes

Definition at line 1503 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta2, m_countRxFailureSta2, m_countRxSuccessSta2, and NS_TEST_ASSERT_MSG_EQ.

Referenced by RunOne().

Here is the caller graph for this function:

◆ DoCheckPhyState()

void TestDlOfdmaPhyPuncturing::DoCheckPhyState	(	Ptr< OfdmaSpectrumWifiPhy >	phy,
		WifiPhyState	expectedState
	)

private

Check the PHY state now.

Parameters

phy	the PHY
expectedState	the expected state of the PHY

Definition at line 1527 of file wifi-phy-ofdma-test.cc.

References ns3::PointerValue::Get(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and NS_TEST_ASSERT_MSG_EQ.

Referenced by CheckPhyState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoRun()

void TestDlOfdmaPhyPuncturing::DoRun ( )

overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

Definition at line 1808 of file wifi-phy-ofdma-test.cc.

References ns3::Simulator::Destroy(), m_indexSubchannel, and RunOne().

Here is the call graph for this function:

◆ DoSetup()

void TestDlOfdmaPhyPuncturing::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 1542 of file wifi-phy-ofdma-test.cc.

References ns3::SpectrumWifiPhy::AddChannel(), ns3::WifiPhy::ConfigureStandard(), m_frequency, m_phyAp, m_phyInterferer, m_phySta1, m_phySta2, ns3::MakeCallback(), RxFailureSta1(), RxFailureSta2(), RxSuccessSta1(), RxSuccessSta2(), ns3::WaveformGenerator::SetChannel(), ns3::SpectrumWifiPhy::SetDevice(), ns3::WaveformGenerator::SetDevice(), ns3::WaveformGenerator::SetDutyCycle(), ns3::WifiPhy::SetErrorRateModel(), ns3::WifiPhy::SetInterferenceHelper(), ns3::WifiPhy::SetMobility(), ns3::WifiPhy::SetReceiveErrorCallback(), ns3::WifiPhy::SetReceiveOkCallback(), and ns3::WIFI_STANDARD_80211ax.

Here is the call graph for this function:

◆ DoTeardown()

void TestDlOfdmaPhyPuncturing::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 1616 of file wifi-phy-ofdma-test.cc.

References ns3::Object::Dispose(), m_phyAp, m_phyInterferer, m_phySta1, and m_phySta2.

Here is the call graph for this function:

◆ GenerateInterference()

void TestDlOfdmaPhyPuncturing::GenerateInterference	(	Ptr< SpectrumValue >	interferencePsd,
		Time	duration
	)

private

Generate interference function.

Parameters

interferencePsd	the PSD of the interference to be generated
duration	the duration of the interference

Definition at line 1434 of file wifi-phy-ofdma-test.cc.

References m_phyInterferer, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::WaveformGenerator::SetPeriod(), ns3::WaveformGenerator::SetTxPowerSpectralDensity(), ns3::WaveformGenerator::Start(), and StopInterference().

Referenced by RunOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetResults()

void TestDlOfdmaPhyPuncturing::ResetResults ( )

private

Reset the results.

Definition at line 1342 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta1, m_countRxBytesSta2, m_countRxFailureSta1, m_countRxFailureSta2, m_countRxSuccessSta1, and m_countRxSuccessSta2.

Referenced by RunOne().

Here is the caller graph for this function:

◆ RunOne()

void TestDlOfdmaPhyPuncturing::RunOne ( )

private

Run one function.

Definition at line 1629 of file wifi-phy-ofdma-test.cc.

References ns3::WifiPhy::AssignStreams(), CheckPhyState(), CheckResultsSta1(), CheckResultsSta2(), ns3::BandInfo::fc, ns3::BandInfo::fh, ns3::WifiPhyOperatingChannel::FindFirst(), ns3::BandInfo::fl, GenerateInterference(), m_channelWidth, m_expectedPpduDuration20Mhz, m_expectedPpduDuration40Mhz, m_frequency, m_indexSubchannel, m_phyAp, m_phySta1, m_phySta2, ns3::NanoSeconds(), ResetResults(), ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), SendMuPpdu(), ns3::WifiPhy::SetOperatingChannel(), ns3::RngSeedManager::SetRun(), ns3::RngSeedManager::SetSeed(), ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_STANDARD_80211ax.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RxFailureSta1()

void TestDlOfdmaPhyPuncturing::RxFailureSta1 ( Ptr< const WifiPsdu > psdu )

private

Receive failure function for STA 1.

Parameters

psdu the PSDU

Definition at line 1473 of file wifi-phy-ofdma-test.cc.

References m_countRxFailureSta1, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ RxFailureSta2()

void TestDlOfdmaPhyPuncturing::RxFailureSta2 ( Ptr< const WifiPsdu > psdu )

private

Receive failure function for STA 2.

Parameters

psdu the PSDU

Definition at line 1480 of file wifi-phy-ofdma-test.cc.

References m_countRxFailureSta2, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ RxSuccessSta1()

void TestDlOfdmaPhyPuncturing::RxSuccessSta1	(	Ptr< const WifiPsdu >	psdu,
		RxSignalInfo	rxSignalInfo,
		WifiTxVector	txVector,
		const std::vector< bool >	statusPerMpdu
	)

private

Receive success function for STA 1.

Parameters

psdu	the PSDU
rxSignalInfo	the info on the received signal (

See also: RxSignalInfo)

Parameters

txVector	the transmit vector
statusPerMpdu	reception status per MPDU

Definition at line 1451 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta1, m_countRxSuccessSta1, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ RxSuccessSta2()

void TestDlOfdmaPhyPuncturing::RxSuccessSta2	(	Ptr< const WifiPsdu >	psdu,
		RxSignalInfo	rxSignalInfo,
		WifiTxVector	txVector,
		std::vector< bool >	statusPerMpdu
	)

private

Receive success function for STA 2.

Parameters

psdu	the PSDU
rxSignalInfo	the info on the received signal (

See also: RxSignalInfo)

Parameters

txVector	the transmit vector
statusPerMpdu	reception status per MPDU

Definition at line 1462 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesSta2, m_countRxSuccessSta2, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ SendMuPpdu()

void TestDlOfdmaPhyPuncturing::SendMuPpdu	(	uint16_t	rxStaId1,
		uint16_t	rxStaId2,
		const std::vector< bool > &	puncturedSubchannels
	)

private

Send MU-PPDU function.

Parameters

rxStaId1	the ID of the recipient STA for the first PSDU
rxStaId2	the ID of the recipient STA for the second PSDU
puncturedSubchannels	indicates for each subchannel whether it is punctured or not. if empty, preamble puncturing is not used.

Definition at line 1353 of file wifi-phy-ofdma-test.cc.

References ns3::HePhy::GetHeMcs7(), ns3::HePhy::GetHeMcs9(), ns3::VhtPhy::GetVhtMcs5(), m_channelWidth, m_phyAp, NS_LOG_FUNCTION, ns3::HeRu::RU_242_TONE, ns3::HeRu::RU_484_TONE, ns3::WifiPhy::Send(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiTxVector::SetInactiveSubchannels(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiTxVector::SetRu(), ns3::WifiTxVector::SetRuAllocation(), ns3::WifiMacHeader::SetSequenceNumber(), ns3::WifiTxVector::SetSigBMode(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_QOSDATA, and ns3::WIFI_PREAMBLE_HE_MU.

Referenced by RunOne().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopInterference()

void TestDlOfdmaPhyPuncturing::StopInterference ( )

private

Stop interference function.

Definition at line 1444 of file wifi-phy-ofdma-test.cc.

References m_phyInterferer, NS_LOG_FUNCTION, and ns3::WaveformGenerator::Stop().

Referenced by GenerateInterference().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_channelWidth

uint16_t TestDlOfdmaPhyPuncturing::m_channelWidth

private

channel width in MHz

Definition at line 1316 of file wifi-phy-ofdma-test.cc.

Referenced by RunOne(), and SendMuPpdu().

◆ m_countRxBytesSta1

uint32_t TestDlOfdmaPhyPuncturing::m_countRxBytesSta1

private

count RX bytes for STA 1

Definition at line 1307 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta1(), ResetResults(), and RxSuccessSta1().

◆ m_countRxBytesSta2

uint32_t TestDlOfdmaPhyPuncturing::m_countRxBytesSta2

private

count RX bytes for STA 2

Definition at line 1308 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta2(), ResetResults(), and RxSuccessSta2().

◆ m_countRxFailureSta1

uint32_t TestDlOfdmaPhyPuncturing::m_countRxFailureSta1

private

count RX failure for STA 1

Definition at line 1305 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta1(), ResetResults(), and RxFailureSta1().

◆ m_countRxFailureSta2

uint32_t TestDlOfdmaPhyPuncturing::m_countRxFailureSta2

private

count RX failure for STA 2

Definition at line 1306 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta2(), ResetResults(), and RxFailureSta2().

◆ m_countRxSuccessSta1

uint32_t TestDlOfdmaPhyPuncturing::m_countRxSuccessSta1

private

count RX success for STA 1

Definition at line 1303 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta1(), ResetResults(), and RxSuccessSta1().

◆ m_countRxSuccessSta2

uint32_t TestDlOfdmaPhyPuncturing::m_countRxSuccessSta2

private

count RX success for STA 2

Definition at line 1304 of file wifi-phy-ofdma-test.cc.

Referenced by CheckResultsSta2(), ResetResults(), and RxSuccessSta2().

◆ m_expectedPpduDuration20Mhz

Time TestDlOfdmaPhyPuncturing::m_expectedPpduDuration20Mhz

private

expected duration to send MU PPDU on 20 MHz RU

Definition at line 1321 of file wifi-phy-ofdma-test.cc.

Referenced by RunOne().

◆ m_expectedPpduDuration40Mhz

Time TestDlOfdmaPhyPuncturing::m_expectedPpduDuration40Mhz

private

expected duration to send MU PPDU on 40 MHz RU

Definition at line 1322 of file wifi-phy-ofdma-test.cc.

Referenced by RunOne().

◆ m_frequency

uint16_t TestDlOfdmaPhyPuncturing::m_frequency

private

frequency in MHz

Definition at line 1315 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), and RunOne().

◆ m_indexSubchannel

uint8_t TestDlOfdmaPhyPuncturing::m_indexSubchannel

private

Index of the subchannel (starting from 0) that should contain an interference and be punctured during the test run.

Definition at line 1318 of file wifi-phy-ofdma-test.cc.

Referenced by DoRun(), and RunOne().

◆ m_phyAp

Ptr<SpectrumWifiPhy> TestDlOfdmaPhyPuncturing::m_phyAp

private

PHY of AP.

Definition at line 1310 of file wifi-phy-ofdma-test.cc.

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

◆ m_phyInterferer

Ptr<WaveformGenerator> TestDlOfdmaPhyPuncturing::m_phyInterferer

private

PHY of interferer.

Definition at line 1313 of file wifi-phy-ofdma-test.cc.

Referenced by DoSetup(), DoTeardown(), GenerateInterference(), and StopInterference().

◆ m_phySta1

Ptr<OfdmaSpectrumWifiPhy> TestDlOfdmaPhyPuncturing::m_phySta1

private

PHY of STA 1.

Definition at line 1311 of file wifi-phy-ofdma-test.cc.

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

◆ m_phySta2

Ptr<OfdmaSpectrumWifiPhy> TestDlOfdmaPhyPuncturing::m_phySta2

private

PHY of STA 2.

Definition at line 1312 of file wifi-phy-ofdma-test.cc.

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

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

src/wifi/test/wifi-phy-ofdma-test.cc

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TestDlOfdmaPhyPuncturing()

Member Function Documentation

◆ CheckPhyState()

◆ CheckResultsSta1()

◆ CheckResultsSta2()

◆ DoCheckPhyState()

◆ DoRun()

◆ DoSetup()

◆ DoTeardown()

◆ GenerateInterference()

◆ ResetResults()

◆ RunOne()

◆ RxFailureSta1()

◆ RxFailureSta2()

◆ RxSuccessSta1()

◆ RxSuccessSta2()

◆ SendMuPpdu()

◆ StopInterference()

Member Data Documentation

◆ m_channelWidth

◆ m_countRxBytesSta1

◆ m_countRxBytesSta2

◆ m_countRxFailureSta1

◆ m_countRxFailureSta2

◆ m_countRxSuccessSta1

◆ m_countRxSuccessSta2

◆ m_expectedPpduDuration20Mhz

◆ m_expectedPpduDuration40Mhz

◆ m_frequency

◆ m_indexSubchannel

◆ m_phyAp

◆ m_phyInterferer

◆ m_phySta1

◆ m_phySta2