A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
OfdmaSpectrumWifiPhy Class Reference

SpectrumWifiPhy used for testing OFDMA. More...

+ Inheritance diagram for OfdmaSpectrumWifiPhy:
+ Collaboration diagram for OfdmaSpectrumWifiPhy:

Public Types

typedef void(* TxPpduUidCallback) (uint64_t uid)
 TracedCallback signature for UID of transmitted PPDU.
 
- Public Types inherited from ns3::SpectrumWifiPhy
typedef void(* SignalArrivalCallback) (Ptr< const SpectrumSignalParameters > signal, uint32_t senderNodeId, double rxPower, Time duration)
 Callback invoked when the PHY model starts to process a signal.
 
- Public Types inherited from ns3::WifiPhy
using ChannelSegments
 segments identifying an operating channel
 
using ChannelTuple
 Tuple identifying a segment of an operating channel.
 
typedef void(* MonitorSnifferRxCallback) (Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, SignalNoiseDbm signalNoise, uint16_t staId)
 TracedCallback signature for monitor mode receive events.
 
typedef void(* MonitorSnifferTxCallback) (const Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, uint16_t staId)
 TracedCallback signature for monitor mode transmit events.
 
typedef void(* PhyRxBeginTracedCallback) (Ptr< const Packet > packet, RxPowerWattPerChannelBand rxPowersW)
 TracedCallback signature for PhyRxBegin trace source.
 
typedef void(* PhyRxMacHeaderEndTracedCallback) (const WifiMacHeader &macHdr, const WifiTxVector &txVector, Time psduDuration)
 TracedCallback signature for end of MAC header reception events.
 
typedef void(* PhyRxPayloadBeginTracedCallback) (WifiTxVector txVector, Time psduDuration)
 TracedCallback signature for start of PSDU reception events.
 
typedef void(* PhyRxPpduDropTracedCallback) (Ptr< const WifiPpdu > ppdu, WifiPhyRxfailureReason reason)
 TracedCallback signature for start of PSDU reception events.
 
typedef void(* PhyTxBeginTracedCallback) (Ptr< const Packet > packet, double txPowerW)
 TracedCallback signature for Phy transmit events.
 
typedef void(* PsduTxBeginCallback) (WifiConstPsduMap psduMap, WifiTxVector txVector, double txPowerW)
 TracedCallback signature for PSDU transmit events.
 
typedef void(* SignalTransmissionCallback) (Ptr< const WifiPpdu > ppdu, const WifiTxVector &txVector)
 Callback invoked when the PHY model starts to transmit a signal.
 

Public Member Functions

 OfdmaSpectrumWifiPhy (uint16_t staId)
 Constructor.
 
 ~OfdmaSpectrumWifiPhy () override
 
void DoDispose () override
 Destructor implementation.
 
void DoInitialize () override
 Initialize() implementation.
 
Ptr< EventGetCurrentEvent ()
 
std::map< std::pair< uint64_t, WifiPreamble >, Ptr< Event > > & GetCurrentPreambleEvents ()
 
Time GetEnergyDuration (Watt_u energy, WifiSpectrumBandInfo band)
 Wrapper to InterferenceHelper method.
 
Ptr< const HePhyGetHePhy () const
 
void Reset ()
 Reset data upon end of TX or RX.
 
void SetPpduUid (uint64_t uid)
 Set the global PPDU UID counter.
 
void SetTriggerFrameUid (uint64_t uid)
 Since we assume trigger frame was previously received from AP, this is used to set its UID.
 
void StartTx (Ptr< const WifiPpdu > ppdu) override
 
- Public Member Functions inherited from ns3::SpectrumWifiPhy
 SpectrumWifiPhy ()
 
 ~SpectrumWifiPhy () override
 
void AddChannel (const Ptr< SpectrumChannel > channel, const FrequencyRange &freqRange=WHOLE_WIFI_SPECTRUM)
 Attach a SpectrumChannel to use for a given frequency range.
 
void ConfigureInterface (const std::vector< MHz_u > &frequencies, MHz_u width)
 Configure a non-active spectrum PHY interface to operate on a given frequency (or several frequencies for non-contiguous) with a given total width.
 
WifiSpectrumBandFrequencies ConvertIndicesToFrequencies (const WifiSpectrumBandIndices &indices) const override
 This is a helper function to convert start and stop indices to start and stop frequencies.
 
Ptr< AntennaModelGetAntenna () const
 Get the antenna model used for reception.
 
WifiSpectrumBandInfo GetBand (MHz_u bandWidth, uint8_t bandIndex=0) override
 Get the info of a given band.
 
Ptr< ChannelGetChannel () const override
 Return the Channel this WifiPhy is connected to.
 
FrequencyRange GetCurrentFrequencyRange () const override
 Get the frequency range of the current RF interface.
 
Ptr< WifiSpectrumPhyInterfaceGetCurrentInterface () const
 Get the currently active spectrum PHY interface.
 
MHz_u GetGuardBandwidth (MHz_u currentChannelWidth) const override
 
Ptr< const WifiPpduGetRxPpduFromTxPpdu (Ptr< const WifiPpdu > ppdu)
 Determine the WifiPpdu to be used by the RX PHY based on the WifiPpdu sent by the TX PHY.
 
const std::map< FrequencyRange, Ptr< WifiSpectrumPhyInterface > > & GetSpectrumPhyInterfaces () const
 Get the map of interfaces attached to this spectrum PHY.
 
std::tuple< dBr_u, dBr_u, dBr_uGetTxMaskRejectionParams () const override
 
void SetAntenna (const Ptr< AntennaModel > antenna)
 
void SetChannelSwitchedCallback (Callback< void > callback)
 
void SetDevice (const Ptr< WifiNetDevice > device) override
 Sets the device this PHY is associated with.
 
void StartRx (Ptr< SpectrumSignalParameters > rxParams, Ptr< const WifiSpectrumPhyInterface > interface)
 Input method for delivering a signal from the spectrum channel and low-level PHY interface to this SpectrumWifiPhy instance.
 
void StartTx (Ptr< const WifiPpdu > ppdu) override
 
void Transmit (Ptr< WifiSpectrumSignalParameters > txParams)
 This function is sending the signal to the Spectrum channel after finishing the configuration of the transmit parameters.
 
- Public Member Functions inherited from ns3::WifiPhy
 WifiPhy ()
 
 ~WifiPhy () override
 
virtual int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model.
 
double CalculateSnr (const WifiTxVector &txVector, double ber) const
 
virtual void ConfigureStandard (WifiStandard standard)
 Configure the PHY-level parameters for different Wi-Fi standard.
 
void EndReceiveInterBss ()
 For HE receptions only, check and possibly modify the transmit power restriction state at the end of PPDU reception.
 
Time GetAckTxTime () const
 Return the estimated Ack TX time for this PHY.
 
Time GetBlockAckTxTime () const
 Return the estimated BlockAck TX time for this PHY.
 
std::list< uint8_t > GetBssMembershipSelectorList () const
 The WifiPhy::BssMembershipSelector() method is used (e.g., by a WifiRemoteStationManager) to determine the set of transmission/reception modes that this WifiPhy(-derived class) can support - a set of WifiMode objects which we call the BssMembershipSelectorSet, and which is stored inside HT PHY (and above) instances.
 
dBm_u GetCcaEdThreshold () const
 Return the CCA energy detection threshold.
 
dBm_u GetCcaSensitivityThreshold () const
 Return the CCA sensitivity threshold.
 
uint8_t GetChannelNumber () const
 Return current channel number.
 
Time GetChannelSwitchDelay () const
 
MHz_u GetChannelWidth () const
 
WifiMode GetDefaultMode () const
 Get the default WifiMode supported by the PHY.
 
Time GetDelayUntilIdle ()
 
Ptr< WifiNetDeviceGetDevice () const
 Return the device this PHY is associated with.
 
MHz_u GetFrequency () const
 
Time GetLastRxEndTime () const
 Return the end time of the last received packet.
 
Time GetLastRxStartTime () const
 Return the start time of the last received packet.
 
Ptr< PhyEntityGetLatestPhyEntity () const
 Get the latest PHY entity supported by this PHY instance.
 
WifiModulationClass GetMaxModulationClassSupported () const
 
uint8_t GetMaxSupportedRxSpatialStreams () const
 
uint8_t GetMaxSupportedTxSpatialStreams () const
 
WifiMode GetMcs (WifiModulationClass modulation, uint8_t mcs) const
 Get the WifiMode object corresponding to the given MCS of the given modulation class.
 
std::list< WifiModeGetMcsList () const
 The WifiPhy::GetMcsList() method is used (e.g., by a WifiRemoteStationManager) to determine the set of transmission/reception MCS indices that this WifiPhy(-derived class) can support - a set of MCS indices which is stored by each HT PHY (and above).
 
std::list< WifiModeGetMcsList (WifiModulationClass modulation) const
 Get the list of supported MCSs for the given modulation class (i.e.
 
Ptr< MobilityModelGetMobility () const
 Return the mobility model this PHY is associated with.
 
std::list< WifiModeGetModeList () const
 The WifiPhy::GetModeList() method is used (e.g., by a WifiRemoteStationManager) to determine the set of transmission/reception (non-MCS) modes that this WifiPhy(-derived class) can support - a set of modes which is stored by each non-HT PHY.
 
std::list< WifiModeGetModeList (WifiModulationClass modulation) const
 Get the list of supported (non-MCS) modes for the given modulation class (i.e.
 
uint16_t GetNMcs () const
 
uint8_t GetNTxPower () const
 Return the number of available transmission power levels.
 
uint8_t GetNumberOfAntennas () const
 
const WifiPhyOperatingChannelGetOperatingChannel () const
 Get a const reference to the operating channel.
 
WifiPhyBand GetPhyBand () const
 Get the configured Wi-Fi band.
 
Ptr< PhyEntityGetPhyEntity (WifiModulationClass modulation) const
 Get the supported PHY entity corresponding to the modulation class.
 
Ptr< PhyEntityGetPhyEntity (WifiStandard standard) const
 Get the supported PHY entity corresponding to the wifi standard.
 
Ptr< PhyEntityGetPhyEntityForPpdu (const Ptr< const WifiPpdu > ppdu) const
 Get the supported PHY entity to use for a received PPDU.
 
uint8_t GetPhyId () const
 Get the index allocated to this PHY.
 
Time GetPifs () const
 Return the PCF Interframe Space (PIFS) for this PHY.
 
dBm_u GetPower (uint8_t powerLevel) const
 Get the power of the given power level.
 
uint64_t GetPreviouslyRxPpduUid () const
 
uint8_t GetPrimary20Index () const
 
uint8_t GetPrimaryChannelNumber (MHz_u primaryChannelWidth) const
 Get channel number of the primary channel.
 
dB_u GetRxGain () const
 Return the reception gain.
 
dBm_u GetRxSensitivity () const
 Return the receive sensitivity threshold.
 
bool GetShortPhyPreambleSupported () const
 Return whether short PHY preamble is supported.
 
Time GetSifs () const
 Return the Short Interframe Space (SIFS) for this PHY.
 
Time GetSlot () const
 Return the slot duration for this PHY.
 
WifiStandard GetStandard () const
 Get the configured Wi-Fi standard.
 
Ptr< WifiPhyStateHelperGetState () const
 Return the WifiPhyStateHelper of this PHY.
 
Hz_u GetSubcarrierSpacing () const
 
MHz_u GetTxBandwidth (WifiMode mode, MHz_u maxAllowedBandWidth=std::numeric_limits< MHz_u >::max()) const
 Get the bandwidth for a transmission occurring on the current operating channel and using the given WifiMode, subject to the constraint that the TX bandwidth cannot exceed the given maximum allowed value.
 
dB_u GetTxGain () const
 Return the transmission gain.
 
dBm_u GetTxPowerEnd () const
 Return the maximum available transmission power level.
 
dBm_u GetTxPowerForTransmission (Ptr< const WifiPpdu > ppdu) const
 Compute the transmit power for the next transmission.
 
dBm_u GetTxPowerStart () const
 Return the minimum available transmission power level.
 
bool HasFixedPhyBand () const
 
bool IsMcsSupported (WifiModulationClass modulation, uint8_t mcs) const
 Check if the given MCS of the given modulation class is supported by the PHY.
 
bool IsModeSupported (WifiMode mode) const
 Check if the given WifiMode is supported by the PHY.
 
bool IsReceivingPhyHeader () const
 
bool IsStateCcaBusy () const
 
bool IsStateIdle () const
 
bool IsStateOff () const
 
bool IsStateRx () const
 
bool IsStateSleep () const
 
bool IsStateSwitching () const
 
bool IsStateTx () const
 
void NotifyChannelAccessRequested ()
 Notify the PHY that an access to the channel was requested.
 
void NotifyMonitorSniffRx (Ptr< const WifiPsdu > psdu, MHz_u channelFreq, WifiTxVector txVector, SignalNoiseDbm signalNoise, std::vector< bool > statusPerMpdu, uint16_t staId=SU_STA_ID)
 Public method used to fire a MonitorSniffer trace for a wifi PSDU being received.
 
void NotifyMonitorSniffTx (Ptr< const WifiPsdu > psdu, MHz_u channelFreq, WifiTxVector txVector, uint16_t staId=SU_STA_ID)
 Public method used to fire a MonitorSniffer trace for a wifi PSDU being transmitted.
 
void NotifyRxBegin (Ptr< const WifiPsdu > psdu, const RxPowerWattPerChannelBand &rxPowersW)
 Public method used to fire a PhyRxBegin trace.
 
void NotifyRxDrop (Ptr< const WifiPsdu > psdu, WifiPhyRxfailureReason reason)
 Public method used to fire a PhyRxDrop trace.
 
void NotifyRxEnd (Ptr< const WifiPsdu > psdu)
 Public method used to fire a PhyRxEnd trace.
 
void NotifyRxPpduDrop (Ptr< const WifiPpdu > ppdu, WifiPhyRxfailureReason reason)
 Public method used to fire a PhyRxPpduDrop trace.
 
void NotifyTxBegin (const WifiConstPsduMap &psdus, Watt_u txPower)
 Public method used to fire a PhyTxBegin trace.
 
void NotifyTxDrop (Ptr< const WifiPsdu > psdu)
 Public method used to fire a PhyTxDrop trace.
 
void NotifyTxEnd (const WifiConstPsduMap &psdus)
 Public method used to fire a PhyTxEnd trace.
 
void RegisterListener (const std::shared_ptr< WifiPhyListener > &listener)
 
void ResetCca (bool powerRestricted, dBm_u txPowerMaxSiso=0, dBm_u txPowerMaxMimo=0)
 Reset PHY to IDLE, with some potential TX power restrictions for the next transmission.
 
void ResumeFromOff ()
 Resume from off mode.
 
void ResumeFromSleep ()
 Resume from sleep mode.
 
void Send (const WifiConstPsduMap &psdus, const WifiTxVector &txVector)
 
void Send (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
 This function is a wrapper for the Send variant that accepts a WifiConstPsduMap as first argument.
 
void SetCapabilitiesChangedCallback (Callback< void > callback)
 
void SetCcaEdThreshold (dBm_u threshold)
 Sets the CCA energy detection threshold.
 
void SetCcaSensitivityThreshold (dBm_u threshold)
 Sets the CCA sensitivity threshold.
 
void SetErrorRateModel (const Ptr< ErrorRateModel > model)
 Sets the error rate model.
 
void SetFixedPhyBand (bool enable)
 Configure whether it is prohibited to change PHY band after initialization.
 
void SetFrameCaptureModel (const Ptr< FrameCaptureModel > frameCaptureModel)
 Sets the frame capture model.
 
virtual void SetInterferenceHelper (const Ptr< InterferenceHelper > helper)
 Sets the interference helper.
 
void SetMaxModulationClassSupported (WifiModulationClass modClass)
 Set the maximum modulation class that has to be supported by this PHY object.
 
void SetMaxSupportedRxSpatialStreams (uint8_t streams)
 
void SetMaxSupportedTxSpatialStreams (uint8_t streams)
 
void SetMobility (const Ptr< MobilityModel > mobility)
 assign a mobility model to this device
 
void SetNTxPower (uint8_t n)
 Sets the number of transmission power levels available between the minimum level and the maximum level.
 
void SetNumberOfAntennas (uint8_t antennas)
 
void SetOffMode ()
 Put in off mode.
 
void SetOperatingChannel (const ChannelSegments &channelSegments)
 This overloaded function is used to pass a list of segments from which the operating channel can be deduced.
 
void SetOperatingChannel (const ChannelTuple &tuple)
 This overloaded function is used when the operating channel consists of a single segment, identified by a tuple.
 
void SetOperatingChannel (const WifiPhyOperatingChannel &channel)
 If the standard for this object has not been set yet, store the channel settings corresponding to the given operating channel.
 
void SetPhyId (uint8_t phyId)
 Set the index allocated to this PHY.
 
void SetPifs (Time pifs)
 Set the PCF Interframe Space (PIFS) for this PHY.
 
void SetPostReceptionErrorModel (const Ptr< ErrorModel > em)
 Attach a receive ErrorModel to the WifiPhy.
 
void SetPreambleDetectionModel (const Ptr< PreambleDetectionModel > preambleDetectionModel)
 Sets the preamble detection model.
 
void SetPreviouslyRxPpduUid (uint64_t uid)
 Set the UID of the previously received PPDU.
 
void SetReceiveErrorCallback (RxErrorCallback callback)
 
void SetReceiveOkCallback (RxOkCallback callback)
 
void SetRxGain (dB_u gain)
 Sets the reception gain.
 
void SetRxNoiseFigure (dB_u noiseFigure)
 Sets the RX loss in the Signal-to-Noise-Ratio due to non-idealities in the receiver.
 
void SetRxSensitivity (dBm_u threshold)
 Sets the receive sensitivity threshold.
 
void SetShortPhyPreambleSupported (bool preamble)
 Enable or disable short PHY preamble.
 
void SetSifs (Time sifs)
 Set the Short Interframe Space (SIFS) for this PHY.
 
void SetSleepMode ()
 Put in sleep mode.
 
void SetSlot (Time slot)
 Set the slot duration for this PHY.
 
void SetTxGain (dB_u gain)
 Sets the transmission gain.
 
void SetTxPowerEnd (dBm_u end)
 Sets the maximum available transmission power level.
 
void SetTxPowerStart (dBm_u start)
 Sets the minimum available transmission power level.
 
void SetWifiRadioEnergyModel (const Ptr< WifiRadioEnergyModel > wifiRadioEnergyModel)
 Sets the wifi radio energy model.
 
void StartReceivePreamble (Ptr< const WifiPpdu > ppdu, RxPowerWattPerChannelBand &rxPowersW, Time rxDuration)
 Start receiving the PHY preamble of a PPDU (i.e.
 
void UnregisterListener (const std::shared_ptr< WifiPhyListener > &listener)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::SpectrumWifiPhy
static uint32_t GetNumBandsBetweenSegments (const std::vector< MHz_u > &centerFrequencies, MHz_u totalWidth, uint32_t subcarrierSpacing)
 Determine the number of bands between the two segments if the operating channel is made of non-contiguous segments, otherwise the function returns zero.
 
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::WifiPhy
static void AddStaticPhyEntity (WifiModulationClass modulation, Ptr< PhyEntity > phyEntity)
 Add the PHY entity to the map of implemented PHY entities for the given modulation class.
 
static Time CalculatePhyPreambleAndHeaderDuration (const WifiTxVector &txVector)
 
static Time CalculateTxDuration (const WifiConstPsduMap &psduMap, const WifiTxVector &txVector, WifiPhyBand band)
 
static Time CalculateTxDuration (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, WifiPhyBand band)
 This function is a wrapper for the CalculateTxDuration variant that accepts a WifiConstPsduMap as first argument.
 
static Time CalculateTxDuration (uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, uint16_t staId=SU_STA_ID)
 
static uint32_t GetMaxPsduSize (WifiModulationClass modulation)
 Get the maximum PSDU size in bytes for the given modulation class.
 
static Time GetPayloadDuration (uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, MpduType mpdutype, bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols, uint16_t staId)
 
static Time GetPayloadDuration (uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, MpduType mpdutype=NORMAL_MPDU, uint16_t staId=SU_STA_ID)
 
static Time GetPreambleDetectionDuration ()
 
static Time GetStartOfPacketDuration (const WifiTxVector &txVector)
 
static const Ptr< const PhyEntityGetStaticPhyEntity (WifiModulationClass modulation)
 Get the implemented PHY entity corresponding to the modulation class.
 
static TypeId GetTypeId ()
 Get the type ID.
 
static WifiConstPsduMap GetWifiConstPsduMap (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
 Get a WifiConstPsduMap from a PSDU and the TXVECTOR to use to send the PSDU.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Attributes

Ptr< OfdmaTestHePhym_ofdmTestHePhy
 Pointer to HE PHY instance used for OFDMA test.
 
TracedCallback< uint64_t > m_phyTxPpduUidTrace
 Callback providing UID of the PPDU that is about to be transmitted.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::SpectrumWifiPhy
void DoChannelSwitch () override
 Actually switch channel based on the stored channel settings.
 
void DoDispose () override
 Destructor implementation.
 
void DoInitialize () override
 Initialize() implementation.
 
- Protected Member Functions inherited from ns3::WifiPhy
void AddPhyEntity (WifiModulationClass modulation, Ptr< PhyEntity > phyEntity)
 Add the PHY entity to the map of supported PHY entities for the given modulation class for the WifiPhy instance.
 
void DoDispose () override
 Destructor implementation.
 
void DoInitialize () override
 Initialize() implementation.
 
std::optional< TimeGetDelayUntilChannelSwitch ()
 Perform any actions necessary when user changes operating channel after initialization.
 
void NotifyCcaBusy (const Ptr< const WifiPpdu > ppdu, Time duration)
 Notify PHY state helper to switch to CCA busy state,.
 
void Reset ()
 Reset data upon end of TX or RX.
 
void SwitchMaybeToCcaBusy (const Ptr< const WifiPpdu > ppdu=nullptr)
 Check if PHY state should move to CCA busy state based on current state of interference tracker.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 
- Protected Attributes inherited from ns3::SpectrumWifiPhy
Ptr< WifiSpectrumPhyInterfacem_currentSpectrumPhyInterface
 The current Spectrum PHY interface (held for performance reasons)
 
std::map< FrequencyRange, Ptr< WifiSpectrumPhyInterface > > m_spectrumPhyInterfaces
 Spectrum PHY interfaces.
 
- Protected Attributes inherited from ns3::WifiPhy
Ptr< Eventm_currentEvent
 Hold the current event.
 
std::map< std::pair< uint64_t, WifiPreamble >, Ptr< Event > > m_currentPreambleEvents
 store event associated to a PPDU (that has a unique ID and preamble combination) whose preamble is being received
 
EventId m_endPhyRxEvent
 the end of PHY receive event
 
EventId m_endTxEvent
 the end of transmit event
 
Ptr< InterferenceHelperm_interference
 Pointer to a helper responsible for interference computations.
 
std::map< WifiModulationClass, Ptr< PhyEntity > > m_phyEntities
 This map holds the supported PHY entities.
 
uint8_t m_phyId
 the index of the PHY in the vector of PHYs held by the WifiNetDevice
 
uint64_t m_previouslyRxPpduUid
 UID of the previously received PPDU, reset to UINT64_MAX upon transmission.
 
Ptr< UniformRandomVariablem_random
 Provides uniform random variables.
 
uint32_t m_rxMpduReferenceNumber
 A-MPDU reference number to identify all received subframes belonging to the same received A-MPDU.
 
TracedCallback< Ptr< const WifiPpdu >, const WifiTxVector & > m_signalTransmissionCb
 Signal Transmission callback.
 
Ptr< WifiPhyStateHelperm_state
 Pointer to WifiPhyStateHelper.
 
uint32_t m_txMpduReferenceNumber
 A-MPDU reference number to identify all transmitted subframes belonging to the same received A-MPDU.
 

Detailed Description

SpectrumWifiPhy used for testing OFDMA.

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

Member Typedef Documentation

◆ TxPpduUidCallback

typedef void(* OfdmaSpectrumWifiPhy::TxPpduUidCallback) (uint64_t uid)

TracedCallback signature for UID of transmitted PPDU.

Parameters
uidthe UID of the transmitted PPDU

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

Constructor & Destructor Documentation

◆ OfdmaSpectrumWifiPhy()

OfdmaSpectrumWifiPhy::OfdmaSpectrumWifiPhy ( uint16_t staId)

Constructor.

Parameters
staIdthe ID of the STA to which this PHY belongs to

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

References ns3::Create(), m_ofdmTestHePhy, and ns3::PhyEntity::SetOwner().

+ Here is the call graph for this function:

◆ ~OfdmaSpectrumWifiPhy()

OfdmaSpectrumWifiPhy::~OfdmaSpectrumWifiPhy ( )
override

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

Member Function Documentation

◆ DoDispose()

void OfdmaSpectrumWifiPhy::DoDispose ( )
overridevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

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

References ns3::SpectrumWifiPhy::DoDispose(), and m_ofdmTestHePhy.

+ Here is the call graph for this function:

◆ DoInitialize()

void OfdmaSpectrumWifiPhy::DoInitialize ( )
overridevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

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

References ns3::SpectrumWifiPhy::DoInitialize(), m_ofdmTestHePhy, ns3::WifiPhy::m_phyEntities, and ns3::WIFI_MOD_CLASS_HE.

+ Here is the call graph for this function:

◆ GetCurrentEvent()

Ptr< Event > OfdmaSpectrumWifiPhy::GetCurrentEvent ( )
Returns
the current event

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

References ns3::WifiPhy::m_currentEvent.

Referenced by TestPhyPaddingExclusion::VerifyEventsCleared(), and TestUlOfdmaPhyTransmission::VerifyEventsCleared().

+ Here is the caller graph for this function:

◆ GetCurrentPreambleEvents()

std::map< std::pair< uint64_t, WifiPreamble >, Ptr< Event > > & OfdmaSpectrumWifiPhy::GetCurrentPreambleEvents ( )
Returns
the current preamble events map

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

References ns3::WifiPhy::m_currentPreambleEvents.

Referenced by TestMultipleHeTbPreambles::CheckHeTbPreambles().

+ Here is the caller graph for this function:

◆ GetEnergyDuration()

Time OfdmaSpectrumWifiPhy::GetEnergyDuration ( Watt_u energy,
WifiSpectrumBandInfo band )

Wrapper to InterferenceHelper method.

Parameters
energythe minimum energy requested
bandidentify the requested band
Returns
the expected amount of time the observed energy on the medium for a given band will be higher than the requested threshold.

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

References ns3::WifiPhy::m_interference.

◆ GetHePhy()

Ptr< const HePhy > OfdmaSpectrumWifiPhy::GetHePhy ( ) const
Returns
a const pointer to the HE PHY instance

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

References ns3::DynamicCast(), and ns3::WifiPhy::GetLatestPhyEntity().

Referenced by TestMultipleHeTbPreambles::RxHeTbPpdu(), and TestUlOfdmaPhyTransmission::SchedulePowerMeasurementChecks().

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

◆ GetTypeId()

TypeId OfdmaSpectrumWifiPhy::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

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

References m_phyTxPpduUidTrace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ Reset()

void ns3::WifiPhy::Reset ( )

Reset data upon end of TX or RX.

Definition at line 1277 of file wifi-phy.cc.

Referenced by TestMultipleHeTbPreambles::Reset().

+ Here is the caller graph for this function:

◆ SetPpduUid()

void OfdmaSpectrumWifiPhy::SetPpduUid ( uint64_t uid)

Set the global PPDU UID counter.

Parameters
uidthe value to which the global PPDU UID counter should be set

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

References m_ofdmTestHePhy, ns3::WifiPhy::m_previouslyRxPpduUid, and OfdmaTestHePhy::SetGlobalPpduUid().

Referenced by TestPhyPaddingExclusion::Reset(), TestUlOfdmaPhyTransmission::Reset(), and TestUlOfdmaPpduUid::ResetPpduUid().

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

◆ SetTriggerFrameUid()

void OfdmaSpectrumWifiPhy::SetTriggerFrameUid ( uint64_t uid)

Since we assume trigger frame was previously received from AP, this is used to set its UID.

Parameters
uidthe PPDU UID of the trigger frame

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

References ns3::WifiPhy::m_previouslyRxPpduUid.

Referenced by TestPhyPaddingExclusion::Reset(), and TestUlOfdmaPhyTransmission::Reset().

+ Here is the caller graph for this function:

◆ StartTx()

void OfdmaSpectrumWifiPhy::StartTx ( Ptr< const WifiPpdu > ppdu)
overridevirtual
Parameters
ppduthe PPDU to send

Implements ns3::WifiPhy.

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

References m_phyTxPpduUidTrace, and ns3::SpectrumWifiPhy::StartTx().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_ofdmTestHePhy

Ptr<OfdmaTestHePhy> OfdmaSpectrumWifiPhy::m_ofdmTestHePhy
private

Pointer to HE PHY instance used for OFDMA test.

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

Referenced by OfdmaSpectrumWifiPhy(), DoDispose(), DoInitialize(), and SetPpduUid().

◆ m_phyTxPpduUidTrace

TracedCallback<uint64_t> OfdmaSpectrumWifiPhy::m_phyTxPpduUidTrace
private

Callback providing UID of the PPDU that is about to be transmitted.

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

Referenced by GetTypeId(), and StartTx().


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