Wifi Phy Threshold Test base class. More...

Inheritance diagram for WifiPhyThresholdsTest:

Collaboration diagram for WifiPhyThresholdsTest:

Public Member Functions
	WifiPhyThresholdsTest (std::string test_name)

virtual	~WifiPhyThresholdsTest ()

Public Member Functions inherited from ns3::TestCase
virtual	~TestCase ()
	Destructor. More...

std::string	GetName (void) const

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< Packet > p)
	PHY receive failure callback function. More...

virtual void	RxSuccess (Ptr< Packet > p, double snr, 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
virtual void	DoSetup (void)
	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 48 of file wifi-phy-thresholds-test.cc.

Constructor & Destructor Documentation

◆ WifiPhyThresholdsTest()

WifiPhyThresholdsTest::WifiPhyThresholdsTest ( std::string test_name )

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

◆ ~WifiPhyThresholdsTest()

WifiPhyThresholdsTest::~WifiPhyThresholdsTest ( )

virtual

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

Member Function Documentation

◆ DoSetup()

void WifiPhyThresholdsTest::DoSetup ( void )

privatevirtual

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

References CHANNEL_NUMBER, ns3::SpectrumWifiPhy::ConfigureStandard(), FREQUENCY, ns3::WifiPhy::GetState(), m_phy, ns3::MakeCallback(), PhyStateChanged(), RxDropped(), RxFailure(), RxSuccess(), ns3::SpectrumWifiPhy::SetChannelNumber(), ns3::WifiPhy::SetErrorRateModel(), ns3::SpectrumWifiPhy::SetFrequency(), ns3::WifiPhy::SetReceiveErrorCallback(), ns3::WifiPhy::SetReceiveOkCallback(), ns3::ObjectBase::TraceConnectWithoutContext(), and ns3::WIFI_PHY_STANDARD_80211ax_5GHZ.

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

References CHANNEL_WIDTH, ns3::SpectrumSignalParameters::duration, FREQUENCY, ns3::SpectrumSignalParameters::psd, ns3::Seconds(), and ns3::SpectrumSignalParameters::txPhy.

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

References ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::Packet::AddTrailer(), ns3::WifiPhy::CalculateTxDuration(), CHANNEL_WIDTH, ns3::SpectrumSignalParameters::duration, FREQUENCY, ns3::WifiPhy::GetFrequency(), ns3::WifiTxVector::GetMode(), ns3::WifiMode::GetModulationClass(), ns3::WifiTxVector::GetPreambleType(), ns3::WifiMacTrailer::GetSerializedSize(), ns3::Packet::GetSize(), m_phy, ns3::WifiSpectrumSignalParameters::packet, ns3::SpectrumSignalParameters::psd, ns3::SpectrumSignalParameters::txPhy, ns3::WIFI_MAC_QOSDATA, 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 208 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 201 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< Packet > p )

protectedvirtual

PHY receive failure callback function.

Parameters

p	the packet

Definition at line 194 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< Packet >	p,
		double	snr,
		WifiTxVector	txVector,
		std::vector< bool >	statusPerMpdu
	)

protectedvirtual

PHY receive success callback function.

Parameters

p	the packet
snr	the SNR
txVector	the transmit vector
statusPerMpdu	reception status per MPDU

Definition at line 187 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 174 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 107 of file wifi-phy-thresholds-test.cc.

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

◆ m_idleStateCount

uint32_t WifiPhyThresholdsTest::m_idleStateCount

protected

count number of PHY state change to IDLE state

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

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

◆ m_phy

Ptr<SpectrumWifiPhy> WifiPhyThresholdsTest::m_phy

protected

PHY object.

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

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

◆ m_rxDropped

uint32_t WifiPhyThresholdsTest::m_rxDropped

protected

count number of dropped packets

Definition at line 103 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 102 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 105 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 101 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 104 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()

◆ 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