Wifi Phy Threshold Test base class. More...

Inheritance diagram for WifiPhyThresholdsTest:

Collaboration diagram for WifiPhyThresholdsTest:

Public Member Functions
	WifiPhyThresholdsTest (std::string test_name)
	Constructor. More...

virtual	~WifiPhyThresholdsTest ()
	Destructor. More...

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

virtual	~TestCase ()
	Destructor. More...

std::string	GetName (void) const

TestCase &	operator= (const TestCase &)=delete

Protected Member Functions
virtual Ptr< SpectrumSignalParameters >	MakeForeignSignal (double txPowerWatts)
	Make foreign signal function. More...

virtual Ptr< SpectrumSignalParameters >	MakeWifiSignal (double txPowerWatts)
	Make wifi signal function. More...

virtual void	PhyStateChanged (Time start, Time duration, WifiPhyState newState)
	PHY state changed callback function. More...

void	RxDropped (Ptr< const Packet > p, WifiPhyRxfailureReason reason)
	PHY dropped packet callback function. More...

virtual void	RxFailure (Ptr< WifiPsdu > psdu)
	PHY receive failure callback function. More...

virtual void	RxSuccess (Ptr< WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, std::vector< bool > statusPerMpdu)
	PHY receive success callback function. More...

virtual void	SendSignal (double txPowerWatts, bool wifiSignal)
	Send signal function. 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 TestCsse. More...

bool	IsStatusFailure (void) const
	Check if any tests failed. More...

bool	IsStatusSuccess (void) 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 (void) const
	Check if this run should assert on failure. More...

bool	MustContinueOnFailure (void) 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...

Protected Attributes
uint32_t	m_ccabusyStateCount
	count number of PHY state change to CCA_BUSY state More...

uint32_t	m_idleStateCount
	count number of PHY state change to IDLE state More...

Ptr< SpectrumWifiPhy >	m_phy
	PHY object. More...

uint32_t	m_rxDropped
	count number of dropped packets More...

uint32_t	m_rxFailure
	count number of unsuccessfully received packets More...

uint32_t	m_rxStateCount
	count number of PHY state change to RX state More...

uint32_t	m_rxSuccess
	count number of successfully received packets More...

uint32_t	m_stateChanged
	count number of PHY state change More...

Private Member Functions
void	DoSetup (void) override
	Implementation to do any local setup required for this TestCase. More...

void	DoTeardown (void) override
	Implementation to do any local setup required for this TestCase. 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...

Detailed Description

Wifi Phy Threshold Test base class.

Definition at line 49 of file wifi-phy-thresholds-test.cc.

Constructor & Destructor Documentation

◆ WifiPhyThresholdsTest()

WifiPhyThresholdsTest::WifiPhyThresholdsTest ( std::string test_name )

Constructor.

Parameters

test_name the test name

Definition at line 124 of file wifi-phy-thresholds-test.cc.

◆ ~WifiPhyThresholdsTest()

WifiPhyThresholdsTest::~WifiPhyThresholdsTest ( )

virtual

Destructor.

Definition at line 136 of file wifi-phy-thresholds-test.cc.

Member Function Documentation

◆ DoSetup()

void WifiPhyThresholdsTest::DoSetup ( void )

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 231 of file wifi-phy-thresholds-test.cc.

References CHANNEL_NUMBER, ns3::WifiPhy::ConfigureStandard(), ns3::WifiPhy::GetState(), m_phy, ns3::MakeCallback(), PhyStateChanged(), RxDropped(), RxFailure(), RxSuccess(), ns3::WifiPhy::SetErrorRateModel(), ns3::WifiPhy::SetInterferenceHelper(), ns3::WifiPhy::SetOperatingChannel(), ns3::WifiPhy::SetReceiveErrorCallback(), ns3::WifiPhy::SetReceiveOkCallback(), ns3::ObjectBase::TraceConnectWithoutContext(), ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_STANDARD_80211ax.

Here is the call graph for this function:

◆ DoTeardown()

void WifiPhyThresholdsTest::DoTeardown ( void )

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 247 of file wifi-phy-thresholds-test.cc.

References ns3::Object::Dispose(), and m_phy.

Here is the call graph for this function:

◆ MakeForeignSignal()

Ptr< SpectrumSignalParameters > WifiPhyThresholdsTest::MakeForeignSignal ( double txPowerWatts )

protectedvirtual

Make foreign signal function.

Parameters

txPowerWatts the transmit power in watts

Returns: Ptr<SpectrumSignalParameters>

Definition at line 166 of file wifi-phy-thresholds-test.cc.

References CHANNEL_WIDTH, FREQUENCY, and ns3::Seconds().

Referenced by SendSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeWifiSignal()

Ptr< SpectrumSignalParameters > WifiPhyThresholdsTest::MakeWifiSignal ( double txPowerWatts )

protectedvirtual

Make wifi signal function.

Parameters

txPowerWatts the transmit power in watts

Returns: Ptr<SpectrumSignalParameters>

Definition at line 141 of file wifi-phy-thresholds-test.cc.

References ns3::WifiPhy::CalculateTxDuration(), CHANNEL_WIDTH, FREQUENCY, ns3::WifiPhy::GetPhyBand(), ns3::WifiPsdu::GetSize(), m_phy, ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_QOSDATA, ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_PREAMBLE_LONG.

Referenced by SendSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PhyStateChanged()

void WifiPhyThresholdsTest::PhyStateChanged	(	Time	start,
		Time	duration,
		WifiPhyState	newState
	)

protectedvirtual

PHY state changed callback function.

Parameters

start	the start time of the new state
duration	the duration of the new state
newState	the new state

Definition at line 212 of file wifi-phy-thresholds-test.cc.

References CCA_BUSY, IDLE, m_ccabusyStateCount, m_idleStateCount, m_rxStateCount, m_stateChanged, NS_LOG_FUNCTION, RX, and visualizer.core::start().

Referenced by DoSetup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RxDropped()

void WifiPhyThresholdsTest::RxDropped	(	Ptr< const Packet >	p,
		WifiPhyRxfailureReason	reason
	)

protected

PHY dropped packet callback function.

Parameters

p	the packet
reason	the reason

Definition at line 205 of file wifi-phy-thresholds-test.cc.

References m_rxDropped, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ RxFailure()

void WifiPhyThresholdsTest::RxFailure ( Ptr< WifiPsdu > psdu )

protectedvirtual

PHY receive failure callback function.

Parameters

psdu the PSDU

Definition at line 198 of file wifi-phy-thresholds-test.cc.

References m_rxFailure, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ RxSuccess()

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

protectedvirtual

PHY receive success callback 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 190 of file wifi-phy-thresholds-test.cc.

References m_rxSuccess, and NS_LOG_FUNCTION.

Referenced by DoSetup().

Here is the caller graph for this function:

◆ SendSignal()

void WifiPhyThresholdsTest::SendSignal	(	double	txPowerWatts,
		bool	wifiSignal
	)

protectedvirtual

Send signal function.

Parameters

txPowerWatts	the transmit power in watts
wifiSignal	whether the signal is a wifi signal or not

Definition at line 177 of file wifi-phy-thresholds-test.cc.

References m_phy, MakeForeignSignal(), MakeWifiSignal(), and ns3::SpectrumWifiPhy::StartRx().

Referenced by WifiPhyThresholdsWeakWifiSignalTest::DoRun(), WifiPhyThresholdsWeakForeignSignalTest::DoRun(), WifiPhyThresholdsStrongWifiSignalTest::DoRun(), and WifiPhyThresholdsStrongForeignSignalTest::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_ccabusyStateCount

uint32_t WifiPhyThresholdsTest::m_ccabusyStateCount

protected

count number of PHY state change to CCA_BUSY state

Definition at line 117 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsStrongWifiSignalTest::DoRun(), and PhyStateChanged().

◆ m_idleStateCount

uint32_t WifiPhyThresholdsTest::m_idleStateCount

protected

count number of PHY state change to IDLE state

Definition at line 116 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsStrongWifiSignalTest::DoRun(), WifiPhyThresholdsStrongForeignSignalTest::DoRun(), and PhyStateChanged().

◆ m_phy

Ptr<SpectrumWifiPhy> WifiPhyThresholdsTest::m_phy

protected

PHY object.

Definition at line 110 of file wifi-phy-thresholds-test.cc.

Referenced by DoSetup(), DoTeardown(), MakeWifiSignal(), and SendSignal().

◆ m_rxDropped

uint32_t WifiPhyThresholdsTest::m_rxDropped

protected

count number of dropped packets

Definition at line 113 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsWeakWifiSignalTest::DoRun(), WifiPhyThresholdsWeakForeignSignalTest::DoRun(), WifiPhyThresholdsStrongWifiSignalTest::DoRun(), WifiPhyThresholdsStrongForeignSignalTest::DoRun(), and RxDropped().

◆ m_rxFailure

uint32_t WifiPhyThresholdsTest::m_rxFailure

protected

count number of unsuccessfully received packets

Definition at line 112 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsWeakWifiSignalTest::DoRun(), WifiPhyThresholdsWeakForeignSignalTest::DoRun(), WifiPhyThresholdsStrongWifiSignalTest::DoRun(), WifiPhyThresholdsStrongForeignSignalTest::DoRun(), and RxFailure().

◆ m_rxStateCount

uint32_t WifiPhyThresholdsTest::m_rxStateCount

protected

count number of PHY state change to RX state

Definition at line 115 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsStrongWifiSignalTest::DoRun(), and PhyStateChanged().

◆ m_rxSuccess

uint32_t WifiPhyThresholdsTest::m_rxSuccess

protected

count number of successfully received packets

Definition at line 111 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsWeakWifiSignalTest::DoRun(), WifiPhyThresholdsWeakForeignSignalTest::DoRun(), WifiPhyThresholdsStrongWifiSignalTest::DoRun(), WifiPhyThresholdsStrongForeignSignalTest::DoRun(), and RxSuccess().

◆ m_stateChanged

uint32_t WifiPhyThresholdsTest::m_stateChanged

protected

count number of PHY state change

Definition at line 114 of file wifi-phy-thresholds-test.cc.

Referenced by WifiPhyThresholdsWeakWifiSignalTest::DoRun(), WifiPhyThresholdsWeakForeignSignalTest::DoRun(), WifiPhyThresholdsStrongWifiSignalTest::DoRun(), and PhyStateChanged().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WifiPhyThresholdsTest()

◆ ~WifiPhyThresholdsTest()

Member Function Documentation

◆ DoSetup()

◆ DoTeardown()

◆ MakeForeignSignal()

◆ MakeWifiSignal()

◆ PhyStateChanged()

◆ RxDropped()

◆ RxFailure()

◆ RxSuccess()

◆ SendSignal()

Member Data Documentation

◆ m_ccabusyStateCount

◆ m_idleStateCount

◆ m_phy

◆ m_rxDropped

◆ m_rxFailure

◆ m_rxStateCount

◆ m_rxSuccess

◆ m_stateChanged