PHY padding exclusion test. More...

Inheritance diagram for TestPhyPaddingExclusion:

Collaboration diagram for TestPhyPaddingExclusion:

Public Member Functions
	TestPhyPaddingExclusion ()

	~TestPhyPaddingExclusion () override

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)
	Check the PHY state.

void	CheckRxFromSta1 (uint32_t expectedSuccess, uint32_t expectedFailures, uint32_t expectedBytes)
	Check the received PSDUs from STA1.

void	CheckRxFromSta2 (uint32_t expectedSuccess, uint32_t expectedFailures, uint32_t expectedBytes)
	Check the received PSDUs from STA2.

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

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	Reset ()
	Reset function.

void	RunOne ()
	Run one function.

void	RxFailure (Ptr< const WifiPsdu > psdu)
	Receive failure function.

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

void	SendHeTbPpdu (uint16_t txStaId, std::size_t index, std::size_t payloadSize, Time txDuration)
	Send HE TB PPDU function.

void	SetTrigVector (Time ppduDuration)
	Set TRIGVECTOR for HE TB PPDU.

void	StopInterference ()
	Stop interference function.

void	VerifyEventsCleared ()
	Verify all events are cleared at end of TX or RX.

Private Attributes
uint32_t	m_countRxBytesFromSta1
	count RX bytes from STA 1

uint32_t	m_countRxBytesFromSta2
	count RX bytes from STA 2

uint32_t	m_countRxFailureFromSta1
	count RX failure from STA 1

uint32_t	m_countRxFailureFromSta2
	count RX failure from STA 2

uint32_t	m_countRxSuccessFromSta1
	count RX success from STA 1

uint32_t	m_countRxSuccessFromSta2
	count RX success from STA 2

Ptr< OfdmaSpectrumWifiPhy >	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

PHY padding exclusion test.

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

Constructor & Destructor Documentation

◆ TestPhyPaddingExclusion()

TestPhyPaddingExclusion::TestPhyPaddingExclusion ( )

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

◆ ~TestPhyPaddingExclusion()

TestPhyPaddingExclusion::~TestPhyPaddingExclusion ( )

override

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

Member Function Documentation

◆ CheckPhyState()

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

private

Check the PHY state.

Parameters

phy	the PHY
expectedState	the expected state of the PHY

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

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

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckRxFromSta1()

void TestPhyPaddingExclusion::CheckRxFromSta1	(	uint32_t	expectedSuccess,
		uint32_t	expectedFailures,
		uint32_t	expectedBytes
	)

private

Check the received PSDUs from STA1.

Parameters

expectedSuccess	the expected number of success
expectedFailures	the expected number of failures
expectedBytes	the expected number of bytes

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

References m_countRxBytesFromSta1, m_countRxFailureFromSta1, m_countRxSuccessFromSta1, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

Here is the caller graph for this function:

◆ CheckRxFromSta2()

void TestPhyPaddingExclusion::CheckRxFromSta2	(	uint32_t	expectedSuccess,
		uint32_t	expectedFailures,
		uint32_t	expectedBytes
	)

private

Check the received PSDUs from STA2.

Parameters

expectedSuccess	the expected number of success
expectedFailures	the expected number of failures
expectedBytes	the expected number of bytes

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

References m_countRxBytesFromSta2, m_countRxFailureFromSta2, m_countRxSuccessFromSta2, and NS_TEST_ASSERT_MSG_EQ.

Referenced by DoRun().

Here is the caller graph for this function:

◆ DoCheckPhyState()

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

private

Check the PHY state.

Parameters

phy	the PHY
expectedState	the expected state of the PHY

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

References 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 TestPhyPaddingExclusion::DoRun ( )

overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

Implements ns3::TestCase.

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

References CheckPhyState(), CheckRxFromSta1(), CheckRxFromSta2(), DEFAULT_CHANNEL_WIDTH, DEFAULT_FREQUENCY, ns3::Simulator::Destroy(), ns3::BandInfo::fc, ns3::BandInfo::fh, ns3::BandInfo::fl, GenerateInterference(), m_phyAp, ns3::MicroSeconds(), ns3::MilliSeconds(), ns3::NanoSeconds(), Reset(), ns3::Simulator::Run(), ns3::Simulator::Schedule(), ns3::Seconds(), SendHeTbPpdu(), SetTrigVector(), and VerifyEventsCleared().

Here is the call graph for this function:

◆ DoSetup()

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

References ns3::SpectrumWifiPhy::AddChannel(), ns3::WifiPhy::AssignStreams(), ns3::WifiPhy::ConfigureStandard(), DEFAULT_CHANNEL_WIDTH, DEFAULT_FREQUENCY, ns3::WifiPhyOperatingChannel::FindFirst(), m_phyAp, m_phyInterferer, m_phySta1, m_phySta2, ns3::MakeCallback(), RxFailure(), RxSuccess(), ns3::WaveformGenerator::SetChannel(), ns3::SpectrumWifiPhy::SetDevice(), ns3::WaveformGenerator::SetDevice(), ns3::WaveformGenerator::SetDutyCycle(), ns3::WifiPhy::SetErrorRateModel(), ns3::WifiPhy::SetInterferenceHelper(), ns3::WifiPhy::SetMobility(), ns3::WifiPhy::SetOperatingChannel(), ns3::WifiPhy::SetReceiveErrorCallback(), ns3::WifiPhy::SetReceiveOkCallback(), ns3::RngSeedManager::SetRun(), ns3::RngSeedManager::SetSeed(), ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_STANDARD_80211ax.

Here is the call graph for this function:

◆ DoTeardown()

void TestPhyPaddingExclusion::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 5162 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 TestPhyPaddingExclusion::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 4928 of file wifi-phy-ofdma-test.cc.

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

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void TestPhyPaddingExclusion::Reset ( )

private

Reset function.

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

References m_countRxBytesFromSta1, m_countRxBytesFromSta2, m_countRxFailureFromSta1, m_countRxFailureFromSta2, m_countRxSuccessFromSta1, m_countRxSuccessFromSta2, m_phySta1, m_phySta2, OfdmaSpectrumWifiPhy::SetPpduUid(), and OfdmaSpectrumWifiPhy::SetTriggerFrameUid().

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RunOne()

void TestPhyPaddingExclusion::RunOne ( )

private

Run one function.

◆ RxFailure()

void TestPhyPaddingExclusion::RxFailure ( Ptr< const WifiPsdu > psdu )

private

Receive failure function.

Parameters

psdu the PSDU

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

References m_countRxFailureFromSta1, m_countRxFailureFromSta2, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ RxSuccess()

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

private

Receive success function.

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 4947 of file wifi-phy-ofdma-test.cc.

References m_countRxBytesFromSta1, m_countRxBytesFromSta2, m_countRxSuccessFromSta1, m_countRxSuccessFromSta2, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ SendHeTbPpdu()

void TestPhyPaddingExclusion::SendHeTbPpdu	(	uint16_t	txStaId,
		std::size_t	index,
		std::size_t	payloadSize,
		Time	txDuration
	)

private

Send HE TB PPDU function.

Parameters

txStaId	the ID of the TX STA
index	the RU index used for the transmission
payloadSize	the size of the payload in bytes
txDuration	the duration of the PPDU

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

References ns3::HePhy::ConvertHeTbPpduDurationToLSigLength(), DEFAULT_CHANNEL_WIDTH, ns3::HePhy::GetHeMcs7(), m_phySta1, m_phySta2, ns3::HeRu::RU_106_TONE, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiTxVector::SetLength(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiTxVector::SetRu(), ns3::WifiMacHeader::SetSequenceNumber(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_QOSDATA, and ns3::WIFI_PREAMBLE_HE_TB.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetTrigVector()

void TestPhyPaddingExclusion::SetTrigVector ( Time ppduDuration )

private

Set TRIGVECTOR for HE TB PPDU.

Parameters

ppduDuration the duration of the HE TB PPDU

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

References ns3::HePhy::ConvertHeTbPpduDurationToLSigLength(), DEFAULT_CHANNEL_WIDTH, ns3::HePhy::GetHeMcs7(), ns3::WifiPhy::GetLatestPhyEntity(), ns3::WifiPhy::GetPhyBand(), m_phyAp, ns3::HeRu::RU_106_TONE, ns3::WifiTxVector::SetLength(), ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetNss(), ns3::WifiTxVector::SetRu(), and ns3::WIFI_PREAMBLE_HE_TB.

Referenced by DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StopInterference()

void TestPhyPaddingExclusion::StopInterference ( )

private

Stop interference function.

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

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

Referenced by GenerateInterference().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VerifyEventsCleared()

void TestPhyPaddingExclusion::VerifyEventsCleared ( )

private

Verify all events are cleared at end of TX or RX.

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

References OfdmaSpectrumWifiPhy::GetCurrentEvent(), m_phyAp, m_phySta1, m_phySta2, 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:

Member Data Documentation

◆ m_countRxBytesFromSta1

uint32_t TestPhyPaddingExclusion::m_countRxBytesFromSta1

private

count RX bytes from STA 1

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

Referenced by CheckRxFromSta1(), Reset(), and RxSuccess().

◆ m_countRxBytesFromSta2

uint32_t TestPhyPaddingExclusion::m_countRxBytesFromSta2

private

count RX bytes from STA 2

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

Referenced by CheckRxFromSta2(), Reset(), and RxSuccess().

◆ m_countRxFailureFromSta1

uint32_t TestPhyPaddingExclusion::m_countRxFailureFromSta1

private

count RX failure from STA 1

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

Referenced by CheckRxFromSta1(), Reset(), and RxFailure().

◆ m_countRxFailureFromSta2

uint32_t TestPhyPaddingExclusion::m_countRxFailureFromSta2

private

count RX failure from STA 2

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

Referenced by CheckRxFromSta2(), Reset(), and RxFailure().

◆ m_countRxSuccessFromSta1

uint32_t TestPhyPaddingExclusion::m_countRxSuccessFromSta1

private

count RX success from STA 1

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

Referenced by CheckRxFromSta1(), Reset(), and RxSuccess().

◆ m_countRxSuccessFromSta2

uint32_t TestPhyPaddingExclusion::m_countRxSuccessFromSta2

private

count RX success from STA 2

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

Referenced by CheckRxFromSta2(), Reset(), and RxSuccess().

◆ m_phyAp

Ptr<OfdmaSpectrumWifiPhy> TestPhyPaddingExclusion::m_phyAp

private

PHY of AP.

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

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

◆ m_phyInterferer

Ptr<WaveformGenerator> TestPhyPaddingExclusion::m_phyInterferer

private

PHY of interferer.

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

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

◆ m_phySta1

Ptr<OfdmaSpectrumWifiPhy> TestPhyPaddingExclusion::m_phySta1

private

PHY of STA 1.

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

Referenced by DoSetup(), DoTeardown(), Reset(), SendHeTbPpdu(), and VerifyEventsCleared().

◆ m_phySta2

Ptr<OfdmaSpectrumWifiPhy> TestPhyPaddingExclusion::m_phySta2

private

PHY of STA 2.

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

Referenced by DoSetup(), DoTeardown(), Reset(), SendHeTbPpdu(), and VerifyEventsCleared().

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

◆ TestPhyPaddingExclusion()

◆ ~TestPhyPaddingExclusion()

Member Function Documentation

◆ CheckPhyState()

◆ CheckRxFromSta1()

◆ CheckRxFromSta2()

◆ DoCheckPhyState()

◆ DoRun()

◆ DoSetup()

◆ DoTeardown()

◆ GenerateInterference()

◆ Reset()

◆ RunOne()

◆ RxFailure()

◆ RxSuccess()

◆ SendHeTbPpdu()

◆ SetTrigVector()

◆ StopInterference()

◆ VerifyEventsCleared()

Member Data Documentation

◆ m_countRxBytesFromSta1

◆ m_countRxBytesFromSta2

◆ m_countRxFailureFromSta1

◆ m_countRxFailureFromSta2

◆ m_countRxSuccessFromSta1

◆ m_countRxSuccessFromSta2

◆ m_phyAp

◆ m_phyInterferer

◆ m_phySta1

◆ m_phySta2