A Discrete-Event Network Simulator
API
SpectrumWifiPhyMultipleInterfacesTest Class Reference

Spectrum Wifi Phy Multiple Spectrum Test. More...

+ Inheritance diagram for SpectrumWifiPhyMultipleInterfacesTest:
+ Collaboration diagram for SpectrumWifiPhyMultipleInterfacesTest:

Public Member Functions

 SpectrumWifiPhyMultipleInterfacesTest (bool trackSignalsInactiveInterfaces)
 Constructor. More...
 
- Public Member Functions inherited from ns3::TestCase
 TestCase (const TestCase &)=delete
 
virtual ~TestCase ()
 Destructor. More...
 
std::string GetName () const
 
TestCaseoperator= (const TestCase &)=delete
 

Private Member Functions

void CheckCcaIndication (std::size_t index, bool expectedCcaBusyIndication, Time switchingDelay)
 Verify CCA indication reported by a given PHY. More...
 
void CheckInterferences (Ptr< SpectrumWifiPhy > phy, const FrequencyRange &freqRange, const WifiSpectrumBandInfo &band, bool interferencesExpected)
 Schedule now to check the interferences. More...
 
void CheckResults (std::size_t index, uint32_t expectedNumRx, FrequencyRange expectedFrequencyRangeActiveRfInterface, const std::vector< std::size_t > &expectedConnectedPhysPerChannel)
 Verify results. More...
 
void DoCheckInterferences (Ptr< SpectrumWifiPhy > phy, const WifiSpectrumBandInfo &band, bool interferencesExpected)
 Check the interferences. More...
 
void DoRun () override
 Implementation to actually run this TestCase. More...
 
void DoSetup () override
 Implementation to do any local setup required for this TestCase. More...
 
void DoTeardown () override
 Implementation to do any local setup required for this TestCase. More...
 
void Reset ()
 Reset function. More...
 
void RxCallback (std::size_t index, Ptr< const Packet > packet, RxPowerWattPerChannelBand rxPowersW)
 Callback triggered when a packet is received by a PHY. More...
 
void SendPpdu (Ptr< SpectrumWifiPhy > phy, double txPowerDbm)
 Send PPDU function. More...
 
void SwitchChannel (std::size_t index, WifiPhyBand band, uint8_t channelNumber, uint16_t channelWidth)
 Switch channel function. More...
 

Private Attributes

std::vector< uint32_t > m_counts {0}
 count number of packets received by PHYs More...
 
Time m_lastTxEnd {0}
 hold the time at which the last transmission ended More...
 
Time m_lastTxStart {0}
 hold the time at which the last transmission started More...
 
std::vector< std::shared_ptr< TestPhyListener > > m_listeners {}
 listeners More...
 
std::vector< Ptr< SpectrumWifiPhy > > m_rxPhys {}
 RX PHYs. More...
 
std::vector< Ptr< MultiModelSpectrumChannel > > m_spectrumChannels
 Spectrum channels. More...
 
bool m_trackSignalsInactiveInterfaces
 flag to indicate whether signals coming from inactive spectrum PHY interfaces are tracked during the test More...
 
std::vector< Ptr< SpectrumWifiPhy > > m_txPhys {}
 TX PHYs. 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...
 
- 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...
 
TestCaseGetParent () const
 Get the parent of this TestCase. More...
 
bool IsStatusFailure () const
 Check if any tests failed. More...
 
bool IsStatusSuccess () 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 () const
 Check if this run should assert on failure. More...
 
bool MustContinueOnFailure () 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...
 

Detailed Description

Spectrum Wifi Phy Multiple Spectrum Test.

This test is testing the ability to plug multiple spectrum channels to the spectrum wifi PHY. It considers 4 TX-RX PHY pairs that are independent from each others and are plugged to different spectrum channels that are covering different frequency range. Each RX PHY is also attached to each of the other 3 spectrum channels it can switch to.

In the first scenario, we consider the default case where each TX-RX PHY pairs are operating on different frequency ranges and hence using independent spectrum channels. We validate that no packets is received from other TX PHYs attached to different spectrum channels and we also verify the amount of connected PHYs to each spectrum channel is exactly 2. The test also makes sure each PHY has only one active spectrum channel and that the active one is operating at the expected frequency range.

In the second scenario, we consecutively switch the channel of all RX PHYs to the one of each TX PHY. We validate that packets are received by all PHYs and we also verify the amount of connected PHYs to each spectrum channels is either 5 (1 TX PHY and 4 RX PHYs) or 1 (the TX PHY left alone).

Definition at line 789 of file spectrum-wifi-phy-test.cc.

Constructor & Destructor Documentation

◆ SpectrumWifiPhyMultipleInterfacesTest()

SpectrumWifiPhyMultipleInterfacesTest::SpectrumWifiPhyMultipleInterfacesTest ( bool  trackSignalsInactiveInterfaces)

Constructor.

Parameters
trackSignalsInactiveInterfacesflag to indicate whether signals coming from inactive spectrum PHY interfaces shall be tracked during the test

Definition at line 904 of file spectrum-wifi-phy-test.cc.

Member Function Documentation

◆ CheckCcaIndication()

void SpectrumWifiPhyMultipleInterfacesTest::CheckCcaIndication ( std::size_t  index,
bool  expectedCcaBusyIndication,
Time  switchingDelay 
)
private

Verify CCA indication reported by a given PHY.

Parameters
indexthe index to identify the RX PHY to check
expectedCcaBusyIndicationflag to indicate whether a CCA BUSY notification is expected
switchingDelaydelay between the TX has started and the time RX switched to the TX channel

Definition at line 1035 of file spectrum-wifi-phy-test.cc.

References m_lastTxEnd, m_lastTxStart, m_listeners, NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_EQ, and ns3::Seconds().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ CheckInterferences()

void SpectrumWifiPhyMultipleInterfacesTest::CheckInterferences ( Ptr< SpectrumWifiPhy phy,
const FrequencyRange freqRange,
const WifiSpectrumBandInfo band,
bool  interferencesExpected 
)
private

Schedule now to check the interferences.

Parameters
phythe PHY for which the check has to be executed
freqRangethe frequency range for which the check has to be executed
bandthe band for which the check has to be executed
interferencesExpectedflag whether interferences are expected to have been tracked

Definition at line 963 of file spectrum-wifi-phy-test.cc.

References DoCheckInterferences(), m_trackSignalsInactiveInterfaces, and third::phy.

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ CheckResults()

void SpectrumWifiPhyMultipleInterfacesTest::CheckResults ( std::size_t  index,
uint32_t  expectedNumRx,
FrequencyRange  expectedFrequencyRangeActiveRfInterface,
const std::vector< std::size_t > &  expectedConnectedPhysPerChannel 
)
private

Verify results.

Parameters
indexthe index to identify the RX PHY to check
expectedNumRxthe expected number of RX events for that PHY
expectedFrequencyRangeActiveRfInterfacethe expected frequency range (in MHz) of the active RF interface
expectedConnectedPhysPerChannelthe expected number of PHYs attached for each spectrum channel

Definition at line 999 of file spectrum-wifi-phy-test.cc.

References m_counts, m_listeners, m_rxPhys, m_spectrumChannels, NS_ASSERT, NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_EQ, and third::phy.

Referenced by DoRun().

+ Here is the caller graph for this function:

◆ DoCheckInterferences()

void SpectrumWifiPhyMultipleInterfacesTest::DoCheckInterferences ( Ptr< SpectrumWifiPhy phy,
const WifiSpectrumBandInfo band,
bool  interferencesExpected 
)
private

Check the interferences.

Parameters
phythe PHY for which the check has to be executed
bandthe band for which the check has to be executed
interferencesExpectedflag whether interferences are expected to have been tracked

Definition at line 983 of file spectrum-wifi-phy-test.cc.

References ns3::PointerValue::Get(), NS_ASSERT, NS_LOG_FUNCTION, NS_TEST_ASSERT_MSG_EQ, and third::phy.

Referenced by CheckInterferences().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoRun()

void SpectrumWifiPhyMultipleInterfacesTest::DoRun ( )
overrideprivatevirtual

Implementation to actually run this TestCase.

Subclasses should override this method to conduct their tests.

< CCA-ED threshold in dBm

< delay in seconds between channel switch is triggered and a transmission gets started

< delay in seconds between start of test and moment results are verified

< delay in seconds between start of test and moment results are flushed

< delay in microseconds between a transmission has started and a point in time the transmission is ongoing

Implements ns3::TestCase.

Definition at line 1186 of file spectrum-wifi-phy-test.cc.

References third::channel, CHANNEL_NUMBER, CHANNEL_WIDTH, CheckCcaIndication(), CheckInterferences(), CheckResults(), two-ray-to-three-gpp-ch-calibration::k, m_rxPhys, m_trackSignalsInactiveInterfaces, m_txPhys, ns3::MicroSeconds(), NS_LOG_FUNCTION, Reset(), ns3::Seconds(), SendPpdu(), SwitchChannel(), check-style-clang-format::type, ns3::WIFI_PHY_BAND_5GHZ, and ns3::WIFI_STANDARD_80211ax.

+ Here is the call graph for this function:

◆ DoSetup()

void SpectrumWifiPhyMultipleInterfacesTest::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.

< frequency range covered by the interface

< channel number the interface operates on

< PHY band the interface operates on

< name of the PHY band the interface operates on

Reimplemented from ns3::TestCase.

Definition at line 1079 of file spectrum-wifi-phy-test.cc.

References ns3::SpectrumWifiPhyHelper::AddChannel(), third::channel, ns3::NodeContainer::Get(), first::interfaces, m_counts, m_listeners, m_rxPhys, m_spectrumChannels, m_trackSignalsInactiveInterfaces, m_txPhys, third::mac, ns3::MakeCallback(), ns3::FrequencyRange::maxFrequency, ns3::FrequencyRange::minFrequency, NS_LOG_FUNCTION, RxCallback(), ns3::WifiPhyHelper::Set(), ns3::WifiPhyHelper::SetPcapDataLinkType(), check-style-clang-format::type, third::wifi, ns3::WIFI_PHY_BAND_2_4GHZ, ns3::WIFI_PHY_BAND_5GHZ, ns3::WIFI_PHY_BAND_6GHZ, ns3::WIFI_SPECTRUM_2_4_GHZ, ns3::WIFI_SPECTRUM_5_GHZ, ns3::WIFI_SPECTRUM_6_GHZ, ns3::WIFI_STANDARD_80211be, and third::wifiApNode.

+ Here is the call graph for this function:

◆ DoTeardown()

void SpectrumWifiPhyMultipleInterfacesTest::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 1169 of file spectrum-wifi-phy-test.cc.

References m_rxPhys, m_txPhys, NS_LOG_FUNCTION, and third::phy.

◆ Reset()

void SpectrumWifiPhyMultipleInterfacesTest::Reset ( )
private

Reset function.

Definition at line 1056 of file spectrum-wifi-phy-test.cc.

References m_counts, m_listeners, m_rxPhys, m_txPhys, NS_LOG_FUNCTION, and SwitchChannel().

Referenced by DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ RxCallback()

void SpectrumWifiPhyMultipleInterfacesTest::RxCallback ( std::size_t  index,
Ptr< const Packet packet,
RxPowerWattPerChannelBand  rxPowersW 
)
private

Callback triggered when a packet is received by a PHY.

Parameters
indexthe index to identify the RX PHY
packetthe received packet
rxPowersWthe received power per channel band in watts

Definition at line 952 of file spectrum-wifi-phy-test.cc.

References m_counts, m_rxPhys, NS_LOG_FUNCTION, and third::phy.

Referenced by DoSetup().

+ Here is the caller graph for this function:

◆ SendPpdu()

void SpectrumWifiPhyMultipleInterfacesTest::SendPpdu ( Ptr< SpectrumWifiPhy phy,
double  txPowerDbm 
)
private

Send PPDU function.

Parameters
phythe PHY to transmit the signal
txPowerDbmthe power in dBm to transmit the signal (this is also the received power since we do not have propagation loss to simplify)

Definition at line 927 of file spectrum-wifi-phy-test.cc.

References m_lastTxEnd, m_lastTxStart, ns3::Now(), NS_LOG_FUNCTION, third::phy, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetSequenceNumber(), ns3::WifiMacHeader::SetType(), ns3::SU_STA_ID, 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:

◆ SwitchChannel()

void SpectrumWifiPhyMultipleInterfacesTest::SwitchChannel ( std::size_t  index,
WifiPhyBand  band,
uint8_t  channelNumber,
uint16_t  channelWidth 
)
private

Switch channel function.

Parameters
indexthe index to identify the RX PHY
bandthe PHY band to use
channelNumbernumber the channel number to use
channelWidththe channel width to use

Definition at line 912 of file spectrum-wifi-phy-test.cc.

References m_listeners, m_rxPhys, NS_LOG_FUNCTION, third::phy, and ns3::Seconds().

Referenced by DoRun(), and Reset().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_counts

std::vector<uint32_t> SpectrumWifiPhyMultipleInterfacesTest::m_counts {0}
private

count number of packets received by PHYs

Definition at line 898 of file spectrum-wifi-phy-test.cc.

Referenced by CheckResults(), DoSetup(), Reset(), and RxCallback().

◆ m_lastTxEnd

Time SpectrumWifiPhyMultipleInterfacesTest::m_lastTxEnd {0}
private

hold the time at which the last transmission ended

Definition at line 901 of file spectrum-wifi-phy-test.cc.

Referenced by CheckCcaIndication(), and SendPpdu().

◆ m_lastTxStart

Time SpectrumWifiPhyMultipleInterfacesTest::m_lastTxStart {0}
private

hold the time at which the last transmission started

Definition at line 900 of file spectrum-wifi-phy-test.cc.

Referenced by CheckCcaIndication(), and SendPpdu().

◆ m_listeners

std::vector<std::shared_ptr<TestPhyListener> > SpectrumWifiPhyMultipleInterfacesTest::m_listeners {}
private

listeners

Definition at line 896 of file spectrum-wifi-phy-test.cc.

Referenced by CheckCcaIndication(), CheckResults(), DoSetup(), Reset(), and SwitchChannel().

◆ m_rxPhys

std::vector<Ptr<SpectrumWifiPhy> > SpectrumWifiPhyMultipleInterfacesTest::m_rxPhys {}
private

RX PHYs.

Definition at line 895 of file spectrum-wifi-phy-test.cc.

Referenced by CheckResults(), DoRun(), DoSetup(), DoTeardown(), Reset(), RxCallback(), and SwitchChannel().

◆ m_spectrumChannels

std::vector<Ptr<MultiModelSpectrumChannel> > SpectrumWifiPhyMultipleInterfacesTest::m_spectrumChannels
private

Spectrum channels.

Definition at line 893 of file spectrum-wifi-phy-test.cc.

Referenced by CheckResults(), and DoSetup().

◆ m_trackSignalsInactiveInterfaces

bool SpectrumWifiPhyMultipleInterfacesTest::m_trackSignalsInactiveInterfaces
private

flag to indicate whether signals coming from inactive spectrum PHY interfaces are tracked during the test

Definition at line 890 of file spectrum-wifi-phy-test.cc.

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

◆ m_txPhys

std::vector<Ptr<SpectrumWifiPhy> > SpectrumWifiPhyMultipleInterfacesTest::m_txPhys {}
private

TX PHYs.

Definition at line 894 of file spectrum-wifi-phy-test.cc.

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


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