802.11 PHY layer model More...
#include "wifi-phy.h"
Public Types | |
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, const 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 | |
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. | |
virtual WifiSpectrumBandFrequencies | ConvertIndicesToFrequencies (const WifiSpectrumBandIndices &indices) const =0 |
This is a helper function to convert start and stop indices to start and stop frequencies. | |
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. | |
virtual WifiSpectrumBandInfo | GetBand (MHz_u bandWidth, uint8_t bandIndex=0)=0 |
Get the info of a given band. | |
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. | |
virtual Ptr< Channel > | GetChannel () const =0 |
Return the Channel this WifiPhy is connected to. | |
uint8_t | GetChannelNumber () const |
Return current channel number. | |
Time | GetChannelSwitchDelay () const |
MHz_u | GetChannelWidth () const |
virtual FrequencyRange | GetCurrentFrequencyRange () const =0 |
Get the frequency range of the current RF interface. | |
WifiMode | GetDefaultMode () const |
Get the default WifiMode supported by the PHY. | |
Time | GetDelayUntilIdle () |
Ptr< WifiNetDevice > | GetDevice () const |
Return the device this PHY is associated with. | |
MHz_u | GetFrequency () const |
virtual MHz_u | GetGuardBandwidth (MHz_u currentChannelWidth) const =0 |
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< PhyEntity > | GetLatestPhyEntity () 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< WifiMode > | GetMcsList () 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< WifiMode > | GetMcsList (WifiModulationClass modulation) const |
Get the list of supported MCSs for the given modulation class (i.e. | |
Ptr< MobilityModel > | GetMobility () const |
Return the mobility model this PHY is associated with. | |
std::list< WifiMode > | GetModeList () 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< WifiMode > | GetModeList (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 WifiPhyOperatingChannel & | GetOperatingChannel () const |
Get a const reference to the operating channel. | |
WifiPhyBand | GetPhyBand () const |
Get the configured Wi-Fi band. | |
Ptr< PhyEntity > | GetPhyEntity (WifiModulationClass modulation) const |
Get the supported PHY entity corresponding to the modulation class. | |
Ptr< PhyEntity > | GetPhyEntity (WifiStandard standard) const |
Get the supported PHY entity corresponding to the wifi standard. | |
Ptr< PhyEntity > | GetPhyEntityForPpdu (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< WifiPhyStateHelper > | GetState () 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. | |
virtual std::tuple< dBr_u, dBr_u, dBr_u > | GetTxMaskRejectionParams () const =0 |
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, const WifiTxVector &txVector, SignalNoiseDbm signalNoise, const 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, const 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. | |
virtual void | SetDevice (const Ptr< WifiNetDevice > device) |
Sets the device this PHY is associated with. | |
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 (bool forceSleepWhileInRx=false) |
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. | |
virtual void | StartTx (Ptr< const WifiPpdu > ppdu)=0 |
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< Object > | GetObject () 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< Object > | GetObject (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. | |
SimpleRefCount & | operator= (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 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 PhyEntity > | GetStaticPhyEntity (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. | |
Protected Member Functions | |
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. | |
virtual void | DoChannelSwitch () |
Actually switch channel based on the stored channel settings. | |
void | DoDispose () override |
Destructor implementation. | |
void | DoInitialize () override |
Initialize() implementation. | |
std::optional< Time > | GetDelayUntilChannelSwitch () |
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 | |
Ptr< Event > | m_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< InterferenceHelper > | m_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< UniformRandomVariable > | m_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< WifiPhyStateHelper > | m_state |
Pointer to WifiPhyStateHelper. | |
uint32_t | m_txMpduReferenceNumber |
A-MPDU reference number to identify all transmitted subframes belonging to the same received A-MPDU. | |
Private Member Functions | |
void | AbortCurrentReception (WifiPhyRxfailureReason reason) |
Due to newly arrived signal, the current reception cannot be continued and has to be aborted. | |
void | Configure80211a () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11a standard. | |
void | Configure80211ac () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11ac standard. | |
void | Configure80211ax () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11ax standard. | |
void | Configure80211b () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11b standard. | |
void | Configure80211be () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11be standard. | |
void | Configure80211g () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11g standard. | |
void | Configure80211n () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11n standard. | |
void | Configure80211p () |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11p standard. | |
void | ConfigureHtDeviceMcsSet () |
Configure the device MCS set with the appropriate HtMcs modes for the number of available transmit spatial streams. | |
virtual void | FinalizeChannelSwitch ()=0 |
Method that can be overridden by subclasses to perform operations after the channel is actually switched but before the MAC is notified of the channel switch. | |
Ptr< const WifiPsdu > | GetAddressedPsduInPpdu (Ptr< const WifiPpdu > ppdu) const |
Get the PSDU addressed to that PHY in a PPDU (useful for MU PPDU). | |
void | PushMcs (WifiMode mode) |
Add the given MCS to the device MCS set. | |
void | RebuildMcsMap () |
Rebuild the mapping of MCS values to indices in the device MCS set. | |
void | TxDone (const WifiConstPsduMap &psdus) |
Callback function when a transmission is completed. | |
Static Private Member Functions | |
static std::map< WifiModulationClass, Ptr< PhyEntity > > & | GetStaticPhyEntities () |
Private Attributes | |
Time | m_ackTxTime |
estimated Ack TX time | |
WifiPhyBand | m_band |
WifiPhyBand. | |
Time | m_blockAckTxTime |
estimated BlockAck TX time | |
Callback< void > | m_capabilitiesChangedCallback |
Callback when PHY capabilities changed. | |
dBm_u | m_ccaEdThreshold |
Clear channel assessment (CCA) energy detection (ED) threshold. | |
dBm_u | m_ccaSensitivityThreshold |
Clear channel assessment (CCA) modulation and coding rate sensitivity threshold. | |
bool | m_channelAccessRequested |
Flag if channels access has been requested (used for OBSS_PD SR) | |
ChannelSegments | m_channelSettings |
Store operating channel settings until initialization. | |
Time | m_channelSwitchDelay |
Time required to switch between channel. | |
Ptr< WifiNetDevice > | m_device |
Pointer to the device. | |
bool | m_fixedPhyBand |
True to prohibit changing PHY band after initialization. | |
Ptr< FrameCaptureModel > | m_frameCaptureModel |
Frame capture model. | |
WifiModulationClass | m_maxModClassSupported |
max modulation class supported | |
Ptr< MobilityModel > | m_mobility |
Pointer to the mobility model. | |
dB_u | m_noiseFigure |
The noise figure. | |
bool | m_notifyRxMacHeaderEnd |
whether the PHY is capable of notifying MAC header RX end | |
uint8_t | m_nTxPower |
Number of available transmission power levels. | |
uint8_t | m_numberOfAntennas |
Number of transmitters. | |
WifiPhyOperatingChannel | m_operatingChannel |
Operating channel. | |
TracedCallback< Ptr< const Packet >, uint16_t, WifiTxVector, MpduInfo, SignalNoiseDbm, uint16_t > | m_phyMonitorSniffRxTrace |
A trace source that emulates a Wi-Fi device in monitor mode sniffing a packet being received. | |
TracedCallback< Ptr< const Packet >, uint16_t, WifiTxVector, MpduInfo, uint16_t > | m_phyMonitorSniffTxTrace |
A trace source that emulates a Wi-Fi device in monitor mode sniffing a packet being transmitted. | |
TracedCallback< Ptr< const Packet >, RxPowerWattPerChannelBand > | m_phyRxBeginTrace |
The trace source fired when a packet begins the reception process from the medium. | |
TracedCallback< Ptr< const Packet >, WifiPhyRxfailureReason > | m_phyRxDropTrace |
The trace source fired when the PHY layer drops a packet it has received. | |
TracedCallback< Ptr< const Packet > > | m_phyRxEndTrace |
The trace source fired when a packet ends the reception process from the medium. | |
TracedCallback< const WifiMacHeader &, const WifiTxVector &, Time > | m_phyRxMacHeaderEndTrace |
The trace source fired when the reception of a MAC header ends. | |
TracedCallback< WifiTxVector, Time > | m_phyRxPayloadBeginTrace |
The trace source fired when the reception of the PHY payload (PSDU) begins. | |
TracedCallback< Ptr< const WifiPpdu >, WifiPhyRxfailureReason > | m_phyRxPpduDropTrace |
The trace source fired when the PHY layer drops a packet it has received. | |
TracedCallback< Ptr< const Packet >, double > | m_phyTxBeginTrace |
The trace source fired when a packet begins the transmission process on the medium. | |
TracedCallback< Ptr< const Packet > > | m_phyTxDropTrace |
The trace source fired when the PHY layer drops a packet as it tries to transmit it. | |
TracedCallback< Ptr< const Packet > > | m_phyTxEndTrace |
The trace source fired when a packet ends the transmission process on the medium. | |
TracedCallback< WifiConstPsduMap, WifiTxVector, double > | m_phyTxPsduBeginTrace |
The trace source fired when a PSDU map begins the transmission process on the medium. | |
Time | m_pifs |
PCF Interframe Space (PIFS) duration. | |
Ptr< ErrorModel > | m_postReceptionErrorModel |
Error model for receive packet events. | |
dBm_per_MHz_u | m_powerDensityLimit |
the power density limit | |
bool | m_powerRestricted |
Flag whether transmit power is restricted by OBSS PD SR. | |
Ptr< PreambleDetectionModel > | m_preambleDetectionModel |
Preamble detection model. | |
dB_u | m_rxGain |
Reception gain. | |
dBm_u | m_rxSensitivity |
Receive sensitivity threshold. | |
uint8_t | m_rxSpatialStreams |
Number of supported RX spatial streams. | |
bool | m_shortPreamble |
Flag if short PHY preamble is supported. | |
Time | m_sifs |
Short Interframe Space (SIFS) duration. | |
Time | m_slot |
Slot duration. | |
WifiStandard | m_standard |
WifiStandard. | |
Time | m_timeLastPreambleDetected |
Record the time the last preamble was detected. | |
dB_u | m_txGain |
Transmission gain. | |
dBm_u | m_txPowerBase |
Minimum transmission power. | |
dBm_u | m_txPowerEnd |
Maximum transmission power. | |
dBm_u | m_txPowerMaxMimo |
MIMO maximum transmit power due to OBSS PD SR power restriction. | |
dBm_u | m_txPowerMaxSiso |
SISO maximum transmit power due to OBSS PD SR power restriction. | |
uint8_t | m_txSpatialStreams |
Number of supported TX spatial streams. | |
Ptr< WifiRadioEnergyModel > | m_wifiRadioEnergyModel |
Wifi radio energy model. | |
Friends | |
class | PhyEntity |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
802.11 PHY layer model
ns3::WifiPhy is accessible through the following paths with Config::Set and Config::Connect:
ns3::Ptr<N3ns310TupleValueIJNS_13UintegerValueES1_NS_9EnumValueINS_11WifiPhyBandEEES1_EEE>
Time
+0ns:+9.22337e+18ns Time
-9.22337e+18ns:+9.22337e+18ns Time
-9.22337e+18ns:+9.22337e+18ns Time
-9.22337e+18ns:+9.22337e+18ns Group: Wifi
Size of this type is 904 bytes (on a 64-bit architecture).
Definition at line 54 of file wifi-phy.h.
segments identifying an operating channel
Definition at line 927 of file wifi-phy.h.
Tuple identifying a segment of an operating channel.
Definition at line 921 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::MonitorSnifferRxCallback) (Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, SignalNoiseDbm signalNoise, uint16_t staId) |
TracedCallback signature for monitor mode receive events.
packet | the packet being received |
channelFreq | the frequency at which the packet is received. Note that in real devices this is normally the frequency to which the receiver is tuned, and this can be different than the frequency at which the packet was originally transmitted. This is because it is possible to have the receiver tuned on a given channel and still to be able to receive packets on a nearby channel. |
txVector | the TXVECTOR that holds RX parameters |
aMpdu | the type of the packet (0 is not A-MPDU, 1 is a MPDU that is part of an A-MPDU and 2 is the last MPDU in an A-MPDU) and the A-MPDU reference number (must be a different value for each A-MPDU but the same for each subframe within one A-MPDU) |
signalNoise | signal power and noise power in dBm |
staId | the STA-ID |
Definition at line 667 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::MonitorSnifferTxCallback) (const Ptr< const Packet > packet, uint16_t channelFreqMhz, WifiTxVector txVector, MpduInfo aMpdu, uint16_t staId) |
TracedCallback signature for monitor mode transmit events.
packet | the packet being transmitted |
channelFreqMhz | the frequency in MHz at which the packet is transmitted. |
txVector | the TXVECTOR that holds TX parameters |
aMpdu | the type of the packet (0 is not A-MPDU, 1 is a MPDU that is part of an A-MPDU and 2 is the last MPDU in an A-MPDU) and the A-MPDU reference number (must be a different value for each A-MPDU but the same for each subframe within one A-MPDU) |
staId | the STA-ID |
Definition at line 706 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::PhyRxBeginTracedCallback) (Ptr< const Packet > packet, RxPowerWattPerChannelBand rxPowersW) |
TracedCallback signature for PhyRxBegin trace source.
packet | the packet being received |
rxPowersW | the receive power per channel band in Watts |
Definition at line 737 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::PhyRxMacHeaderEndTracedCallback) (const WifiMacHeader &macHdr, const WifiTxVector &txVector, Time psduDuration) |
TracedCallback signature for end of MAC header reception events.
macHdr | the MAC header of the MPDU being received |
txVector | the TXVECTOR used to transmit the PSDU |
psduDuration | the remaining duration of the PSDU |
Definition at line 764 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::PhyRxPayloadBeginTracedCallback) (WifiTxVector txVector, Time psduDuration) |
TracedCallback signature for start of PSDU reception events.
txVector | the TXVECTOR decoded from the PHY header |
psduDuration | the duration of the PSDU |
Definition at line 746 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::PhyRxPpduDropTracedCallback) (Ptr< const WifiPpdu > ppdu, WifiPhyRxfailureReason reason) |
TracedCallback signature for start of PSDU reception events.
txVector | the TXVECTOR decoded from the PHY header |
psduDuration | the duration of the PSDU |
Definition at line 754 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::PhyTxBeginTracedCallback) (Ptr< const Packet > packet, double txPowerW) |
TracedCallback signature for Phy transmit events.
packet | the packet being transmitted |
txPowerW | the transmit power in Watts |
Definition at line 718 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::PsduTxBeginCallback) (WifiConstPsduMap psduMap, const WifiTxVector &txVector, double txPowerW) |
TracedCallback signature for PSDU transmit events.
psduMap | the PSDU map being transmitted |
txVector | the TXVECTOR holding the TX parameters |
txPowerW | the transmit power in Watts |
Definition at line 727 of file wifi-phy.h.
typedef void(* ns3::WifiPhy::SignalTransmissionCallback) (Ptr< const WifiPpdu > ppdu, const WifiTxVector &txVector) |
Callback invoked when the PHY model starts to transmit a signal.
ppdu | The PPDU being transmitted |
txVector | txVector used for transmitting the PPDU |
Definition at line 1269 of file wifi-phy.h.
ns3::WifiPhy::WifiPhy | ( | ) |
Definition at line 377 of file wifi-phy.cc.
References ns3::CreateObject(), m_random, m_state, and NS_LOG_FUNCTION.
|
override |
Definition at line 405 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
|
private |
Due to newly arrived signal, the current reception cannot be continued and has to be aborted.
reason | the reason the reception is aborted |
Definition at line 2229 of file wifi-phy.cc.
References NS_LOG_FUNCTION, ns3::OBSS_PD_CCA_RESET, ns3::RECEPTION_ABORTED_BY_TX, and ns3::SIGNAL_DETECTION_ABORTED_BY_TX.
Referenced by ns3::PhyEntity::AbortCurrentReception(), and GetDelayUntilChannelSwitch().
|
protected |
Add the PHY entity to the map of supported PHY entities for the given modulation class for the WifiPhy instance.
This is a wrapper method used to check that the PHY entity is in the static map of implemented PHY entities (
modulation | the modulation class |
phyEntity | the PHY entity |
Definition at line 810 of file wifi-phy.cc.
References GetStaticPhyEntities(), m_phyEntities, NS_ABORT_MSG_IF, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Referenced by Configure80211a(), Configure80211ac(), Configure80211ax(), Configure80211b(), Configure80211be(), Configure80211g(), Configure80211n(), and Configure80211p().
|
static |
Add the PHY entity to the map of implemented PHY entities for the given modulation class.
Through this method, child classes can add their own PHY entities in a static manner.
modulation | the modulation class |
phyEntity | the PHY entity |
Definition at line 801 of file wifi-phy.cc.
References GetStaticPhyEntities(), and NS_ASSERT_MSG.
Referenced by anonymous_namespace{dsss-phy.cc}::ConstructorDsss::ConstructorDsss(), anonymous_namespace{eht-phy.cc}::ConstructorEht::ConstructorEht(), anonymous_namespace{erp-ofdm-phy.cc}::ConstructorErpOfdm::ConstructorErpOfdm(), anonymous_namespace{he-phy.cc}::ConstructorHe::ConstructorHe(), anonymous_namespace{ht-phy.cc}::ConstructorHt::ConstructorHt(), anonymous_namespace{ofdm-phy.cc}::ConstructorOfdm::ConstructorOfdm(), and anonymous_namespace{vht-phy.cc}::ConstructorVht::ConstructorVht().
|
virtual |
Assign a fixed random variable stream number to the random variables used by this model.
Return the number of streams (possibly zero) that have been assigned.
stream | first stream index to use |
Definition at line 2345 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
Referenced by TestMultipleHeTbPreambles::DoRun(), TestUlOfdmaPpduUid::DoRun(), TestWifiPhyRxTraceHelperYans::DoRun(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestDlMuMimoPhyTransmission::RunOne(), TestDlOfdmaPhyPuncturing::RunOne(), TestDlOfdmaPhyTransmission::RunOne(), TestUlMuMimoPhyTransmission::RunOne(), and TestUlOfdmaPhyTransmission::RunOne().
|
static |
txVector | the transmission parameters used for this packet |
Definition at line 1580 of file wifi-phy.cc.
References ns3::WifiTxVector::GetModulationClass().
Referenced by ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), ns3::InterferenceHelper::CalculatePayloadPer(), EmlsrUlTxopTest::CheckQosFrames(), WifiTxopTest::CheckResults(), ns3::DsssPpdu::GetTxDuration(), ns3::VhtPpdu::GetTxDuration(), ns3::HePhy::GetValidPpduDuration(), ns3::FrameExchangeManager::SendMpdu(), ns3::HeFrameExchangeManager::SendMuRts(), ns3::HtFrameExchangeManager::SendPsdu(), ns3::FrameExchangeManager::SendRts(), ns3::DsssPpdu::SetDsssHeader(), ns3::VhtPpdu::SetVhtSigHeader(), BackoffGenerationTest::Transmit(), and ns3::FrameExchangeManager::UpdateNav().
double ns3::WifiPhy::CalculateSnr | ( | const WifiTxVector & | txVector, |
double | ber ) const |
txVector | the transmission vector |
ber | the probability of bit error rate |
Definition at line 745 of file wifi-phy.cc.
References m_interference.
|
static |
psduMap | the PSDU(s) to transmit indexed by STA-ID |
txVector | the TXVECTOR used for the transmission of the PPDU |
band | the frequency band being used |
Definition at line 1607 of file wifi-phy.cc.
References ns3::WifiTxVector::GetModulationClass().
|
static |
This function is a wrapper for the CalculateTxDuration variant that accepts a WifiConstPsduMap as first argument.
This function inserts the given PSDU in a WifiConstPsduMap along with a STA-ID value that is determined based on whether the given PSDU has to be transmitted as a DL or UL frame, thus allowing to properly calculate the TX duration in case the PSDU has to be transmitted as an UL frame.
psdu | the PSDU to transmit |
txVector | the TXVECTOR used for the transmission of the PSDU |
band | the frequency band |
Definition at line 1599 of file wifi-phy.cc.
|
static |
size | the number of bytes in the packet to send |
txVector | the TXVECTOR used for the transmission of this packet |
band | the frequency band being used |
staId | the STA-ID of the recipient (only used for MU) |
Definition at line 1587 of file wifi-phy.cc.
References ns3::Time::IsStrictlyPositive(), ns3::NORMAL_MPDU, and NS_ASSERT.
Referenced by ns3::FrameExchangeManager::CalculateAcknowledgmentTime(), ns3::HtFrameExchangeManager::CalculateAcknowledgmentTime(), ns3::FrameExchangeManager::CalculateProtectionTime(), ns3::HePhy::CalculateTxDuration(), ns3::PhyEntity::CalculateTxDuration(), TxDurationTest::CalculateTxDurationUsingList(), EmlsrDlTxopTest::CheckApEmlNotificationFrame(), EmlsrDlTxopTest::CheckBlockAck(), EmlsrUlTxopTest::CheckBlockAck(), MultiLinkMuTxTest::CheckBlockAck(), MultiLinkTxTest::CheckBlockAck(), EmlsrUlTxopTest::CheckCtsFrames(), EmlOmnExchangeTest::CheckEmlNotification(), EmlsrDlTxopTest::CheckInitialControlFrame(), EmlsrLinkSwitchTest::CheckInitialControlFrame(), MultiLinkSetupTest::CheckQosData(), EmlsrDlTxopTest::CheckQosFrames(), EmlsrUlTxopTest::CheckQosFrames(), EmlsrDlTxopTest::CheckResults(), EmlsrUlTxopTest::CheckResults(), EmlsrDlTxopTest::CheckStaEmlNotificationFrame(), ns3::FrameExchangeManager::DoSendCtsAfterRts(), WifiPrimaryChannelsTest::DoSendHeTbPpdu(), WifiPrimaryChannelsTest::DoSetup(), ns3::FrameExchangeManager::ForwardMpduDown(), ns3::EhtFrameExchangeManager::ForwardPsduDown(), ns3::HtFrameExchangeManager::ForwardPsduDown(), ns3::EhtFrameExchangeManager::ForwardPsduMapDown(), ns3::QosFrameExchangeManager::GetCtsToSelfDurationId(), ns3::DefaultApEmlsrManager::GetDelayOnTxPsduNotForEmlsr(), ns3::RrMultiUserScheduler::GetExtraTimeForBsrpTfDurationId(), ns3::FrameExchangeManager::GetFrameDurationId(), ns3::QosFrameExchangeManager::GetFrameDurationId(), ns3::HeFrameExchangeManager::GetMuRtsDurationId(), ns3::FrameExchangeManager::GetRtsDurationId(), ns3::QosFrameExchangeManager::GetRtsDurationId(), ns3::FrameExchangeManager::GetTxDuration(), ns3::HtPpdu::GetTxDuration(), ns3::OfdmPpdu::GetTxDuration(), ns3::ApWifiMac::ReceiveEmlOmn(), ns3::HtFrameExchangeManager::ReceiveMgtAction(), TestMultipleHeTbPreambles::RxHeTbPpdu(), TestMultiUserScheduler::SelectTxFormat(), ns3::HtFrameExchangeManager::SendBlockAck(), ns3::QosFrameExchangeManager::SendCfEndIfNeeded(), ns3::FrameExchangeManager::SendCtsToSelf(), ns3::FrameExchangeManager::SendMpdu(), ns3::HeFrameExchangeManager::SendMuRts(), ns3::FrameExchangeManager::SendNormalAck(), SpectrumWifiPhyMultipleInterfacesTest::SendPpdu(), ns3::HtFrameExchangeManager::SendPsdu(), ns3::FrameExchangeManager::SendRts(), TestUlOfdmaPpduUid::SendTbPpdu(), WifiRetransmitTest::SetEvents(), ns3::StaWifiMac::SetPmModeAfterAssociation(), BackoffGenerationTest::Transmit(), EmlsrDlTxopTest::Transmit(), EmlsrOperationsTestBase::Transmit(), EmlsrUlOfdmaTest::Transmit(), MultiLinkMuTxTest::Transmit(), OfdmaAckSequenceTest::Transmit(), StartSeqNoUpdateAfterAddBaTimeoutTest::Transmit(), WifiChannelSwitchingTest::Transmit(), WifiTxopTest::Transmit(), WifiUseAvailBwTest::Transmit(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), and ns3::FrameExchangeManager::UpdateNav().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11a standard.
Definition at line 871 of file wifi-phy.cc.
References AddPhyEntity(), ns3::Create(), GetSifs(), GetSlot(), m_ackTxTime, ns3::MicroSeconds(), NS_LOG_FUNCTION, SetPifs(), SetSifs(), SetSlot(), and ns3::WIFI_MOD_CLASS_OFDM.
Referenced by Configure80211n(), and ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11ac standard.
Definition at line 965 of file wifi-phy.cc.
References AddPhyEntity(), Configure80211n(), ns3::Create(), NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_VHT.
Referenced by Configure80211ax(), and ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11ax standard.
Definition at line 973 of file wifi-phy.cc.
References AddPhyEntity(), Configure80211ac(), Configure80211n(), ns3::Create(), m_band, NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_HE, and ns3::WIFI_PHY_BAND_2_4GHZ.
Referenced by Configure80211be(), and ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11b standard.
Definition at line 886 of file wifi-phy.cc.
References AddPhyEntity(), ns3::Create(), GetSifs(), GetSlot(), m_ackTxTime, ns3::MicroSeconds(), NS_LOG_FUNCTION, SetPifs(), SetSifs(), SetSlot(), ns3::WIFI_MOD_CLASS_DSSS, and ns3::WIFI_MOD_CLASS_HR_DSSS.
Referenced by Configure80211g(), and ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11be standard.
Definition at line 988 of file wifi-phy.cc.
References AddPhyEntity(), Configure80211ax(), ns3::Create(), NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_EHT.
Referenced by ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11g standard.
Definition at line 903 of file wifi-phy.cc.
References AddPhyEntity(), Configure80211b(), ns3::Create(), NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_ERP_OFDM.
Referenced by Configure80211n(), and ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11n standard.
Definition at line 946 of file wifi-phy.cc.
References AddPhyEntity(), Configure80211a(), Configure80211g(), ns3::Create(), m_band, m_blockAckTxTime, m_txSpatialStreams, ns3::MicroSeconds(), NS_LOG_FUNCTION, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_PHY_BAND_2_4GHZ.
Referenced by Configure80211ac(), Configure80211ax(), and ConfigureStandard().
|
private |
Configure WifiPhy with appropriate channel frequency and supported rates for 802.11p standard.
Definition at line 916 of file wifi-phy.cc.
References AddPhyEntity(), ns3::Create(), GetChannelWidth(), GetSifs(), GetSlot(), m_ackTxTime, ns3::MicroSeconds(), NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::OFDM_PHY_10_MHZ, ns3::OFDM_PHY_5_MHZ, SetPifs(), SetSifs(), SetSlot(), and ns3::WIFI_MOD_CLASS_OFDM.
Referenced by ConfigureStandard().
|
private |
Configure the device MCS set with the appropriate HtMcs modes for the number of available transmit spatial streams.
|
virtual |
Configure the PHY-level parameters for different Wi-Fi standard.
Note that, in case a Spectrum PHY is used, this method must be called after adding a spectrum channel covering the operating channel bandwidth.
standard | the Wi-Fi standard |
Definition at line 1009 of file wifi-phy.cc.
References Configure80211a(), Configure80211ac(), Configure80211ax(), Configure80211b(), Configure80211be(), Configure80211g(), Configure80211n(), Configure80211p(), ns3::GetModulationClassForStandard(), ns3::WifiPhyOperatingChannel::IsSet(), m_channelSettings, m_maxModClassSupported, m_operatingChannel, m_phyEntities, m_standard, NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, SetOperatingChannel(), ns3::WIFI_MOD_CLASS_UNKNOWN, ns3::WIFI_STANDARD_80211a, ns3::WIFI_STANDARD_80211ac, ns3::WIFI_STANDARD_80211ax, ns3::WIFI_STANDARD_80211b, ns3::WIFI_STANDARD_80211be, ns3::WIFI_STANDARD_80211g, ns3::WIFI_STANDARD_80211n, ns3::WIFI_STANDARD_80211p, and ns3::WIFI_STANDARD_UNSPECIFIED.
Referenced by Bug2831TestCase::DoRun(), SpectrumWifiPhyFilterTest::DoSetup(), SpectrumWifiPhyTrackedBandsTest::DoSetup(), TestDlMuMimoPhyTransmission::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), TestUlOfdmaPpduUid::DoSetup(), and TestWifiPhyRxTraceHelperYans::DoSetup().
|
pure virtual |
This is a helper function to convert start and stop indices to start and stop frequencies.
indices | the start/stop indices to convert |
Implemented in ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Referenced by ns3::HePhy::GetNonOfdmaBand(), ns3::HePhy::GetRuBandForRx(), and ns3::HePhy::GetRuBandForTx().
|
protectedvirtual |
Actually switch channel based on the stored channel settings.
Reimplemented in ns3::SpectrumWifiPhy.
Definition at line 1234 of file wifi-phy.cc.
References ns3::WifiPhyOperatingChannel::GetDefaultChannelNumber(), ns3::GetDefaultChannelWidth(), ns3::GetDefaultPhyBand(), ns3::Object::IsInitialized(), m_band, m_channelAccessRequested, m_channelSettings, m_fixedPhyBand, m_powerRestricted, m_standard, NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::WIFI_PHY_BAND_UNSPECIFIED.
Referenced by ns3::SpectrumWifiPhy::DoChannelSwitch(), and SetOperatingChannel().
|
overrideprotectedvirtual |
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.
Reimplemented in ns3::YansWifiPhy.
Definition at line 436 of file wifi-phy.cc.
References m_device, m_frameCaptureModel, m_interference, m_mobility, m_phyEntities, m_postReceptionErrorModel, m_preambleDetectionModel, m_random, m_state, m_wifiRadioEnergyModel, NS_LOG_FUNCTION, and Reset().
Referenced by ns3::SpectrumWifiPhy::DoDispose(), and ns3::YansWifiPhy::DoDispose().
|
overrideprotectedvirtual |
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 411 of file wifi-phy.cc.
References m_device, m_mobility, NS_ABORT_MSG_UNLESS, NS_LOG_FUNCTION, and NS_LOG_WARN.
Referenced by ns3::SpectrumWifiPhy::DoInitialize().
void ns3::WifiPhy::EndReceiveInterBss | ( | ) |
For HE receptions only, check and possibly modify the transmit power restriction state at the end of PPDU reception.
Definition at line 2007 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
|
privatepure virtual |
Method that can be overridden by subclasses to perform operations after the channel is actually switched but before the MAC is notified of the channel switch.
Implemented in ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Time ns3::WifiPhy::GetAckTxTime | ( | ) | const |
Return the estimated Ack TX time for this PHY.
Definition at line 859 of file wifi-phy.cc.
References m_ackTxTime.
Referenced by ns3::MinstrelWifiManager::CalculateTimeUnicastPacket(), and ns3::ChannelAccessManager::GetEifsNoDifs().
|
private |
Get the PSDU addressed to that PHY in a PPDU (useful for MU PPDU).
ppdu | the PPDU to extract the PSDU from |
Definition at line 2338 of file wifi-phy.cc.
|
pure virtual |
Get the info of a given band.
bandWidth | the width of the band to be returned |
bandIndex | the index of the band to be returned |
Implemented in ExtSpectrumWifiPhy, ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Referenced by ns3::HePhy::GetPer20MHzDurations(), ns3::PhyEntity::GetPrimaryBand(), and ns3::PhyEntity::GetSecondaryBand().
Time ns3::WifiPhy::GetBlockAckTxTime | ( | ) | const |
Return the estimated BlockAck TX time for this PHY.
Definition at line 865 of file wifi-phy.cc.
References m_blockAckTxTime.
Referenced by ns3::MinstrelHtWifiManager::CalculateRetransmits().
std::list< uint8_t > ns3::WifiPhy::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.
Definition at line 1402 of file wifi-phy.cc.
References list.
Referenced by ns3::StaWifiMac::CheckSupportedRates(), ns3::ApWifiMac::GetSupportedRates(), and ns3::StaWifiMac::GetSupportedRates().
dBm_u ns3::WifiPhy::GetCcaEdThreshold | ( | ) | const |
Return the CCA energy detection threshold.
Definition at line 533 of file wifi-phy.cc.
References m_ccaEdThreshold.
Referenced by ns3::PhyEntity::GetCcaThreshold(), ns3::VhtPhy::GetCcaThreshold(), and GetTypeId().
dBm_u ns3::WifiPhy::GetCcaSensitivityThreshold | ( | ) | const |
Return the CCA sensitivity threshold.
Definition at line 546 of file wifi-phy.cc.
References m_ccaSensitivityThreshold.
Referenced by ns3::OfdmPhy::GetCcaThreshold(), ns3::PhyEntity::GetCcaThreshold(), ns3::VhtPhy::GetCcaThreshold(), and GetTypeId().
Return the Channel this WifiPhy is connected to.
Implemented in ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Referenced by ns3::WifiNetDevice::GetChannel(), and GetTypeId().
uint8_t ns3::WifiPhy::GetChannelNumber | ( | ) | const |
Return current channel number.
Definition at line 1093 of file wifi-phy.cc.
References ns3::WifiPhyOperatingChannel::GetNumber(), and m_operatingChannel.
Referenced by ns3::MeshWifiInterfaceMac::GetFrequencyChannel(), GetTypeId(), and ns3::PhyEntity::Transmit().
Time ns3::WifiPhy::GetChannelSwitchDelay | ( | ) | const |
Definition at line 739 of file wifi-phy.cc.
References m_channelSwitchDelay.
MHz_u ns3::WifiPhy::GetChannelWidth | ( | ) | const |
Definition at line 1099 of file wifi-phy.cc.
References ns3::WifiPhyOperatingChannel::GetTotalWidth(), and m_operatingChannel.
Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), ns3::PhyEntity::CanStartRx(), Configure80211p(), ns3::ChannelAccessManager::DoGrantDcfAccess(), ns3::IdealWifiManager::DoReportRtsOk(), ns3::HtPhy::GetCcaIndication(), ns3::VhtPhy::GetCcaIndication(), ns3::OfdmPhy::GetMeasurementChannelWidth(), ns3::HePhy::GetNonOfdmaBand(), ns3::ChannelAccessManager::GetPer20MHzBusy(), ns3::HePhy::GetPer20MHzDurations(), ns3::PhyEntity::GetPrimaryBand(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), ns3::DsssPhy::GetRxChannelWidth(), ns3::PhyEntity::GetRxChannelWidth(), ns3::OfdmPhy::GetRxPpduFromTxPpdu(), ns3::PhyEntity::GetSecondaryBand(), ns3::ApWifiMac::GetSupportedRates(), ns3::StaWifiMac::GetSupportedRates(), GetTxBandwidth(), GetTypeId(), ns3::ThompsonSamplingWifiManager::InitializeStation(), ns3::OfdmPhy::IsChannelWidthSupported(), ns3::WifiRemoteStationManager::LookupState(), ns3::ChannelAccessManager::ResizeLastBusyStructs(), and ns3::SpectrumWifiPhy::StartRx().
|
pure virtual |
Get the frequency range of the current RF interface.
Implemented in ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Referenced by ns3::PhyEntity::CreateInterferenceEvent(), ns3::PhyEntity::EndPreambleDetectionPeriod(), ns3::PhyEntity::NotifyInterferenceRxEndAndClear(), ns3::PhyEntity::ResetReceive(), and ns3::PhyEntity::StartPreambleDetectionPeriod().
WifiMode ns3::WifiPhy::GetDefaultMode | ( | ) | const |
Get the default WifiMode supported by the PHY.
This is the first mode to be added (i.e. the lowest one over all supported PHY entities).
Definition at line 2037 of file wifi-phy.cc.
References NS_ASSERT_MSG.
|
protected |
Perform any actions necessary when user changes operating channel after initialization.
Definition at line 1193 of file wifi-phy.cc.
References AbortCurrentReception(), ns3::CCA_BUSY, ns3::CHANNEL_SWITCHING, GetDelayUntilIdle(), ns3::IDLE, ns3::Object::IsInitialized(), m_state, NS_ASSERT, NS_LOG_DEBUG, Reset(), ns3::RX, ns3::Seconds(), ns3::SLEEP, ns3::SWITCHING, and ns3::TX.
Referenced by SetOperatingChannel().
Time ns3::WifiPhy::GetDelayUntilIdle | ( | ) |
The PHY will never become WifiPhy::IDLE before the delay returned by this method but it could become really idle later.
Definition at line 2197 of file wifi-phy.cc.
Referenced by GetDelayUntilChannelSwitch().
Ptr< WifiNetDevice > ns3::WifiPhy::GetDevice | ( | ) | const |
Return the device this PHY is associated with.
Definition at line 647 of file wifi-phy.cc.
References m_device.
Referenced by ns3::SpectrumWifiPhy::AddChannel(), ns3::HePhy::CanStartRx(), ns3::MinstrelHtWifiManager::DoCreateStation(), ns3::HePhy::DoStartReceivePayload(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::HePhy::GetBssColor(), ns3::VhtPhy::GetCcaThreshold(), ns3::WifiRemoteStationManager::GetControlAnswerMode(), ns3::WifiRemoteStationManager::GetCtsToSelfTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WifiRemoteStationManager::GetEhtSupported(), ns3::WifiRemoteStationManager::GetGuardInterval(), ns3::WifiRemoteStationManager::GetHeSupported(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::WifiRemoteStationManager::GetLdpcSupported(), ns3::HePhy::GetMaxDelayPpduSameUid(), ns3::WifiRemoteStationManager::GetRtsTxVector(), ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported(), ns3::HePhy::GetStaId(), ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::HePhy::SetTrigVector(), and ns3::HePhy::StartTx().
MHz_u ns3::WifiPhy::GetFrequency | ( | ) | const |
Definition at line 1087 of file wifi-phy.cc.
References ns3::WifiPhyOperatingChannel::GetFrequency(), and m_operatingChannel.
Referenced by ns3::PhyEntity::EndReceivePayload(), ns3::HePhy::GetPer20MHzDurations(), and GetTypeId().
currentChannelWidth | channel width of the current transmission |
Note: in order to properly model out of band transmissions for OFDM, the guard band has been configured so as to expand the modeled spectrum up to the outermost referenced point in "Transmit spectrum mask" sections' PSDs of each PHY specification of 802.11-2016 standard. It thus ultimately corresponds to the current channel bandwidth (which can be different from devices max channel width).
This method is only relevant for SpectrumWifiPhy.
Implemented in ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Referenced by ns3::PhyEntity::GetGuardBandwidth().
Time ns3::WifiPhy::GetLastRxEndTime | ( | ) | const |
Return the end time of the last received packet.
Definition at line 2209 of file wifi-phy.cc.
Referenced by ns3::HePhy::DoEndReceivePayload(), and ns3::PhyEntity::DoEndReceivePayload().
Time ns3::WifiPhy::GetLastRxStartTime | ( | ) | const |
Return the start time of the last received packet.
Definition at line 2203 of file wifi-phy.cc.
Get the latest PHY entity supported by this PHY instance.
Definition at line 775 of file wifi-phy.cc.
References GetPhyEntity(), and m_standard.
Referenced by ns3::ErpOfdmPhy::BuildPpdu(), ns3::OfdmPhy::BuildPpdu(), ns3::SpectrumWifiPhy::CanStartRx(), OfdmaSpectrumWifiPhy::GetHePhy(), GetPhyEntityForPpdu(), TestMultipleHeTbPreambles::RxHeTbPpdu(), TestPhyPaddingExclusion::SetTrigVector(), and TestUlOfdmaPhyTransmission::SetTrigVector().
WifiModulationClass ns3::WifiPhy::GetMaxModulationClassSupported | ( | ) | const |
Definition at line 1003 of file wifi-phy.cc.
References m_maxModClassSupported.
|
static |
Get the maximum PSDU size in bytes for the given modulation class.
modulation | the modulation class |
Definition at line 1616 of file wifi-phy.cc.
Referenced by ns3::QosFrameExchangeManager::IsWithinSizeAndTimeLimits().
uint8_t ns3::WifiPhy::GetMaxSupportedRxSpatialStreams | ( | ) | const |
Definition at line 1396 of file wifi-phy.cc.
Referenced by ns3::ApWifiMac::GetEhtOperation(), ns3::ApWifiMac::GetHeOperation(), GetTypeId(), ns3::HePhy::IsConfigSupported(), and ns3::HtPhy::IsConfigSupported().
uint8_t ns3::WifiPhy::GetMaxSupportedTxSpatialStreams | ( | ) | const |
Definition at line 1378 of file wifi-phy.cc.
Referenced by ns3::IdealWifiManager::BuildSnrThresholds(), GetTypeId(), and ns3::ThompsonSamplingWifiManager::InitializeStation().
WifiMode ns3::WifiPhy::GetMcs | ( | WifiModulationClass | modulation, |
uint8_t | mcs ) const |
Get the WifiMode object corresponding to the given MCS of the given modulation class.
modulation | the modulation class |
mcs | the MCS value |
Definition at line 2148 of file wifi-phy.cc.
References NS_ASSERT_MSG.
std::list< WifiMode > ns3::WifiPhy::GetMcsList | ( | ) | 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).
Definition at line 2113 of file wifi-phy.cc.
References list.
Referenced by ns3::WifiRemoteStationManager::AddAllSupportedMcs(), ns3::IdealWifiManager::BuildSnrThresholds(), ns3::WifiRemoteStationManager::GetControlAnswerMode(), ns3::MinstrelHtWifiManager::GetDeviceMcsList(), ns3::ThompsonSamplingWifiManager::InitializeStation(), and ns3::StaWifiMac::UpdateApInfo().
std::list< WifiMode > ns3::WifiPhy::GetMcsList | ( | WifiModulationClass | modulation | ) | const |
Get the list of supported MCSs for the given modulation class (i.e.
corresponding to a given PHY entity).
modulation | the modulation class |
Definition at line 2130 of file wifi-phy.cc.
References list.
Ptr< MobilityModel > ns3::WifiPhy::GetMobility | ( | ) | const |
Return the mobility model this PHY is associated with.
This method will return either the mobility model that has been explicitly set by a call to YansWifiPhy::SetMobility(), or else will return the mobility model (if any) that has been aggregated to the node.
Definition at line 659 of file wifi-phy.cc.
References m_mobility.
std::list< WifiMode > ns3::WifiPhy::GetModeList | ( | ) | 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.
It is important to note that this list is a superset (not necessarily proper) of the OperationalRateSet (which is logically, if not actually, a property of the associated WifiRemoteStationManager), which itself is a superset (again, not necessarily proper) of the BSSBasicRateSet.
Definition at line 2064 of file wifi-phy.cc.
References list.
Referenced by ns3::WifiRemoteStationManager::AddAllSupportedModes(), ns3::IdealWifiManager::BuildSnrThresholds(), ns3::MinstrelHtWifiManager::DoGetRtsTxVector(), ns3::MeshWifiInterfaceMac::Enqueue(), ns3::WifiRemoteStationManager::GetControlAnswerMode(), ns3::ApWifiMac::GetSupportedRates(), ns3::MeshWifiInterfaceMac::GetSupportedRates(), ns3::StaWifiMac::GetSupportedRates(), ns3::MeshWifiInterfaceMac::Receive(), and ns3::StaWifiMac::UpdateApInfo().
std::list< WifiMode > ns3::WifiPhy::GetModeList | ( | WifiModulationClass | modulation | ) | const |
Get the list of supported (non-MCS) modes for the given modulation class (i.e.
corresponding to a given PHY entity).
modulation | the modulation class |
Definition at line 2081 of file wifi-phy.cc.
References list.
uint16_t ns3::WifiPhy::GetNMcs | ( | ) | const |
Definition at line 2099 of file wifi-phy.cc.
uint8_t ns3::WifiPhy::GetNTxPower | ( | ) | const |
Return the number of available transmission power levels.
Definition at line 596 of file wifi-phy.cc.
References m_nTxPower.
uint8_t ns3::WifiPhy::GetNumberOfAntennas | ( | ) | const |
Definition at line 1346 of file wifi-phy.cc.
Referenced by GetTypeId().
const WifiPhyOperatingChannel & ns3::WifiPhy::GetOperatingChannel | ( | ) | const |
Get a const reference to the operating channel.
Definition at line 1081 of file wifi-phy.cc.
References m_operatingChannel.
Referenced by ns3::DsssPhy::BuildPpdu(), ns3::EhtPhy::BuildPpdu(), ns3::ErpOfdmPhy::BuildPpdu(), ns3::HePhy::BuildPpdu(), ns3::HtPhy::BuildPpdu(), ns3::OfdmPhy::BuildPpdu(), ns3::PhyEntity::BuildPpdu(), ns3::VhtPhy::BuildPpdu(), ns3::PhyEntity::CanStartRx(), ns3::SpectrumWifiPhy::DoChannelSwitch(), ns3::ChannelAccessManager::DoGrantDcfAccess(), ns3::SpectrumWifiPhy::FinalizeChannelSwitch(), ns3::YansWifiPhy::FinalizeChannelSwitch(), ns3::HtPhy::GetCcaIndication(), ns3::VhtPhy::GetCcaIndication(), ns3::HePhy::GetCenterFrequenciesForNonHePart(), ns3::SpectrumWifiPhy::GetHeRuBands(), ns3::HePhy::GetNonOfdmaBand(), ns3::HePhy::GetPer20MHzDurations(), ns3::PhyEntity::GetPrimaryBand(), ns3::ApWifiMac::GetReducedNeighborReport(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), ns3::PhyEntity::GetSecondaryBand(), ns3::EhtPhy::GetSigBSize(), ns3::HePhy::GetSigBSize(), ns3::HePhy::GetTxPowerSpectralDensity(), ns3::ChannelAccessManager::ResizeLastBusyStructs(), and TestMultipleHeTbPreambles::RxHeTbPpdu().
|
static |
size | the number of bytes in the packet to send |
txVector | the TXVECTOR used for the transmission of this packet |
band | the frequency band |
mpdutype | the type of the MPDU as defined in WifiPhy::MpduType. |
incFlag | this flag is used to indicate that the variables need to be update or not This function is called a couple of times for the same packet so variables should not be increased each time. |
totalAmpduSize | the total size of the previously transmitted MPDUs for the concerned A-MPDU. If incFlag is set, this parameter will be updated. |
totalAmpduNumSymbols | the number of symbols previously transmitted for the MPDUs in the concerned A-MPDU, used for the computation of the number of symbols needed for the last MPDU. If incFlag is set, this parameter will be updated. |
staId | the STA-ID of the PSDU (only used for MU PPDUs) |
Definition at line 1559 of file wifi-phy.cc.
References ns3::WifiTxVector::GetModulationClass().
|
static |
size | the number of bytes in the packet to send |
txVector | the TXVECTOR used for the transmission of this packet |
band | the frequency band |
mpdutype | the type of the MPDU as defined in WifiPhy::MpduType. |
staId | the STA-ID of the PSDU (only used for MU PPDUs) |
Definition at line 1540 of file wifi-phy.cc.
Referenced by ns3::MinstrelHtWifiManager::CalculateMpduTxDuration(), and ns3::PhyEntity::ScheduleEndOfMpdus().
WifiPhyBand ns3::WifiPhy::GetPhyBand | ( | ) | const |
Get the configured Wi-Fi band.
Definition at line 1069 of file wifi-phy.cc.
References m_band.
Referenced by ns3::WifiRemoteStationManager::AdjustTxVectorForIcf(), ns3::IdealWifiManager::BuildSnrThresholds(), ns3::FrameExchangeManager::CalculateAcknowledgmentTime(), ns3::HtFrameExchangeManager::CalculateAcknowledgmentTime(), ns3::FrameExchangeManager::CalculateProtectionTime(), ns3::ChannelAccessManager::DoGrantDcfAccess(), ns3::FrameExchangeManager::DoSendCtsAfterRts(), ns3::HePhy::DoStartReceivePayload(), ns3::FrameExchangeManager::ForwardMpduDown(), ns3::EhtFrameExchangeManager::ForwardPsduDown(), ns3::HtFrameExchangeManager::ForwardPsduDown(), ns3::EhtFrameExchangeManager::ForwardPsduMapDown(), ns3::QosFrameExchangeManager::GetCtsToSelfDurationId(), ns3::FrameExchangeManager::GetFrameDurationId(), ns3::QosFrameExchangeManager::GetFrameDurationId(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::HeFrameExchangeManager::GetMuRtsDurationId(), ns3::FrameExchangeManager::GetRtsDurationId(), ns3::QosFrameExchangeManager::GetRtsDurationId(), ns3::FrameExchangeManager::GetTxDuration(), ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::HtFrameExchangeManager::ReceiveMgtAction(), TestMultipleHeTbPreambles::RxHeTbPpdu(), ns3::PhyEntity::ScheduleEndOfMpdus(), ns3::HtFrameExchangeManager::SendBlockAck(), ns3::QosFrameExchangeManager::SendCfEndIfNeeded(), ns3::FrameExchangeManager::SendCtsToSelf(), ns3::FrameExchangeManager::SendMpdu(), ns3::HeFrameExchangeManager::SendMuRts(), ns3::FrameExchangeManager::SendNormalAck(), ns3::HtFrameExchangeManager::SendPsdu(), ns3::HeFrameExchangeManager::SendPsduMapWithProtection(), ns3::FrameExchangeManager::SendRts(), TestUlOfdmaPpduUid::SendTbPpdu(), TestPhyPaddingExclusion::SetTrigVector(), TestUlMuMimoPhyTransmission::SetTrigVector(), TestUlOfdmaPhyTransmission::SetTrigVector(), ns3::MeshWifiInterfaceMac::SwitchFrequencyChannel(), and ns3::FrameExchangeManager::UpdateNav().
Ptr< PhyEntity > ns3::WifiPhy::GetPhyEntity | ( | WifiModulationClass | modulation | ) | const |
Get the supported PHY entity corresponding to the modulation class.
modulation | the modulation class |
Definition at line 760 of file wifi-phy.cc.
References m_phyEntities, and NS_ABORT_MSG_IF.
Referenced by ns3::EhtFrameExchangeManager::ForwardPsduDown(), GetLatestPhyEntity(), GetPhyEntity(), GetPhyEntityForPpdu(), TestUlOfdmaPpduUid::SendTbPpdu(), TestUlMuMimoPhyTransmission::SetTrigVector(), and ns3::SpectrumWifiPhy::StartTx().
Ptr< PhyEntity > ns3::WifiPhy::GetPhyEntity | ( | WifiStandard | standard | ) | const |
Get the supported PHY entity corresponding to the wifi standard.
standard | the wifi standard |
Definition at line 769 of file wifi-phy.cc.
References ns3::GetModulationClassForStandard(), and GetPhyEntity().
Get the supported PHY entity to use for a received PPDU.
This typically returns the entity corresponding to the modulation class used to transmit the PPDU. If the modulation class used to transmit the PPDU is not supported by the PHY, the latest PHY entity corresponding to the configured standard is returned. If the modulation used to transmit the PPDU is non-HT (duplicate), the latest PHY entity corresponding to the configured standard is also returned.
ppdu | the received PPDU |
Definition at line 781 of file wifi-phy.cc.
References GetLatestPhyEntity(), GetPhyEntity(), m_phyEntities, NS_ABORT_IF, and ns3::WIFI_MOD_CLASS_HT.
Referenced by ns3::SpectrumWifiPhy::GetRxPpduFromTxPpdu(), and ns3::PhyEntity::HandleRxPpduWithSameContent().
uint8_t ns3::WifiPhy::GetPhyId | ( | ) | const |
Get the index allocated to this PHY.
Definition at line 672 of file wifi-phy.cc.
References m_phyId.
Time ns3::WifiPhy::GetPifs | ( | ) | const |
Return the PCF Interframe Space (PIFS) for this PHY.
Definition at line 853 of file wifi-phy.cc.
References m_pifs.
Referenced by ns3::ChannelAccessManager::DoGrantDcfAccess(), ns3::QosFrameExchangeManager::PifsRecovery(), and ns3::QosFrameExchangeManager::TransmissionFailed().
dBm_u ns3::WifiPhy::GetPower | ( | uint8_t | powerLevel | ) | const |
Get the power of the given power level.
In current implementation, the power levels are equally spaced (in dBm).
powerLevel | the power level |
Definition at line 720 of file wifi-phy.cc.
References m_nTxPower, m_txPowerBase, m_txPowerEnd, NS_ASSERT, and NS_ASSERT_MSG.
Referenced by ns3::AparfWifiManager::CheckInit(), ns3::ParfWifiManager::CheckInit(), ns3::RrpaaWifiManager::CheckInit(), ns3::AparfWifiManager::DoGetDataTxVector(), ns3::ParfWifiManager::DoGetDataTxVector(), ns3::RrpaaWifiManager::DoGetDataTxVector(), and ns3::YansWifiPhy::StartTx().
|
static |
Definition at line 1528 of file wifi-phy.cc.
References ns3::MicroSeconds().
Referenced by ns3::PhyEntity::EndPreambleDetectionPeriod(), TestUlOfdmaPhyTransmission::SchedulePowerMeasurementChecks(), and ns3::PhyEntity::StartPreambleDetectionPeriod().
uint64_t ns3::WifiPhy::GetPreviouslyRxPpduUid | ( | ) | const |
Definition at line 1941 of file wifi-phy.cc.
Referenced by ns3::HePhy::ObtainNextUid().
uint8_t ns3::WifiPhy::GetPrimary20Index | ( | ) | const |
Definition at line 1105 of file wifi-phy.cc.
References ns3::WifiPhyOperatingChannel::GetPrimaryChannelIndex(), and m_operatingChannel.
Referenced by GetTypeId().
uint8_t ns3::WifiPhy::GetPrimaryChannelNumber | ( | MHz_u | primaryChannelWidth | ) | const |
Get channel number of the primary channel.
primaryChannelWidth | the width of the primary channel |
Definition at line 2363 of file wifi-phy.cc.
dB_u ns3::WifiPhy::GetRxGain | ( | ) | const |
Return the reception gain.
Definition at line 622 of file wifi-phy.cc.
References m_rxGain.
Referenced by GetTypeId().
dBm_u ns3::WifiPhy::GetRxSensitivity | ( | ) | const |
Return the receive sensitivity threshold.
Definition at line 520 of file wifi-phy.cc.
References m_rxSensitivity.
Referenced by GetTypeId(), and ns3::SpectrumWifiPhy::StartRx().
bool ns3::WifiPhy::GetShortPhyPreambleSupported | ( | ) | const |
Return whether short PHY preamble is supported.
Definition at line 635 of file wifi-phy.cc.
References m_shortPreamble.
Referenced by GetTypeId().
Time ns3::WifiPhy::GetSifs | ( | ) | const |
Return the Short Interframe Space (SIFS) for this PHY.
Definition at line 829 of file wifi-phy.cc.
References m_sifs.
Referenced by ns3::FrameExchangeManager::CalculateAcknowledgmentTime(), ns3::HtFrameExchangeManager::CalculateAcknowledgmentTime(), ns3::FrameExchangeManager::CalculateProtectionTime(), ns3::MinstrelHtWifiManager::CalculateRetransmits(), ns3::MinstrelWifiManager::CalculateTimeUnicastPacket(), Configure80211a(), Configure80211b(), Configure80211p(), ns3::FrameExchangeManager::DoSendCtsAfterRts(), ns3::HtFrameExchangeManager::EndReceiveAmpdu(), ns3::FrameExchangeManager::GetCtsToSelfDurationId(), ns3::ChannelAccessManager::GetEifsNoDifs(), ns3::FrameExchangeManager::GetFrameDurationId(), ns3::FrameExchangeManager::GetRtsDurationId(), ns3::ChannelAccessManager::GetSifs(), ns3::FrameExchangeManager::ProtectionCompleted(), ns3::HeFrameExchangeManager::ProtectionCompleted(), ns3::HtFrameExchangeManager::ProtectionCompleted(), ns3::HtFrameExchangeManager::ReceiveMgtAction(), ns3::EhtFrameExchangeManager::ReceiveMpdu(), ns3::FrameExchangeManager::ReceiveMpdu(), ns3::HtFrameExchangeManager::ReceiveMpdu(), ns3::QosFrameExchangeManager::ReceiveMpdu(), ns3::HtFrameExchangeManager::SendBlockAck(), ns3::FrameExchangeManager::SendMpdu(), ns3::HeFrameExchangeManager::SendMuRts(), ns3::FrameExchangeManager::SendNormalAck(), ns3::HtFrameExchangeManager::SendPsdu(), ns3::HeFrameExchangeManager::SendPsduMapWithProtection(), ns3::FrameExchangeManager::SendRts(), ns3::FrameExchangeManager::TransmissionSucceeded(), ns3::HeFrameExchangeManager::TransmissionSucceeded(), ns3::HtFrameExchangeManager::TransmissionSucceeded(), ns3::QosFrameExchangeManager::TransmissionSucceeded(), ns3::FrameExchangeManager::UpdateNav(), ns3::EhtFrameExchangeManager::UpdateTxopEndOnRxEnd(), and ns3::EhtFrameExchangeManager::UpdateTxopEndOnTxStart().
Time ns3::WifiPhy::GetSlot | ( | ) | const |
Return the slot duration for this PHY.
Definition at line 841 of file wifi-phy.cc.
References m_slot.
Referenced by ns3::MinstrelHtWifiManager::CalculateRetransmits(), ns3::MinstrelWifiManager::CalculateTimeUnicastPacket(), Configure80211a(), Configure80211b(), Configure80211p(), ns3::ChannelAccessManager::GetSlot(), ns3::FrameExchangeManager::SendMpdu(), ns3::HeFrameExchangeManager::SendMuRts(), ns3::HtFrameExchangeManager::SendPsdu(), ns3::FrameExchangeManager::SendRts(), ns3::FrameExchangeManager::UpdateNav(), ns3::EhtFrameExchangeManager::UpdateTxopEndOnRxEnd(), and ns3::EhtFrameExchangeManager::UpdateTxopEndOnTxStart().
WifiStandard ns3::WifiPhy::GetStandard | ( | ) | const |
Get the configured Wi-Fi standard.
Definition at line 1075 of file wifi-phy.cc.
References m_standard.
Referenced by ns3::WifiMac::ConfigurePhyDependentParameters(), ns3::ChannelAccessManager::ResizeLastBusyStructs(), ns3::SpectrumWifiPhy::StartRx(), and ns3::SpectrumWifiPhy::UpdateInterferenceHelperBands().
|
static |
txVector | the transmission parameters used for this packet |
Definition at line 1534 of file wifi-phy.cc.
References ns3::MicroSeconds().
Ptr< WifiPhyStateHelper > ns3::WifiPhy::GetState | ( | ) | const |
Return the WifiPhyStateHelper of this PHY.
Definition at line 472 of file wifi-phy.cc.
References m_state.
Referenced by ns3::FrameExchangeManager::ResetPhy().
|
staticprivate |
Definition at line 465 of file wifi-phy.cc.
Referenced by AddPhyEntity(), AddStaticPhyEntity(), and GetStaticPhyEntity().
|
static |
Get the implemented PHY entity corresponding to the modulation class.
This is used to compute the different amendment-specific parameters within calling static methods.
modulation | the modulation class |
Definition at line 751 of file wifi-phy.cc.
References GetStaticPhyEntities(), and NS_ABORT_MSG_IF.
Referenced by ns3::InterferenceHelper::CalculatePhyHeaderPer(), and HeSigBDurationTest::DoRun().
Hz_u ns3::WifiPhy::GetSubcarrierSpacing | ( | ) | const |
Definition at line 2369 of file wifi-phy.cc.
References NS_FATAL_ERROR, ns3::WIFI_STANDARD_80211a, ns3::WIFI_STANDARD_80211ac, ns3::WIFI_STANDARD_80211ax, ns3::WIFI_STANDARD_80211b, ns3::WIFI_STANDARD_80211be, ns3::WIFI_STANDARD_80211g, ns3::WIFI_STANDARD_80211n, and ns3::WIFI_STANDARD_80211p.
Referenced by ns3::SpectrumWifiPhy::GetBandForInterface(), ns3::SpectrumWifiPhy::GetHeRuBands(), ns3::HePhy::GetNonOfdmaBand(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), and ns3::SpectrumWifiPhy::ResetSpectrumModel().
MHz_u ns3::WifiPhy::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.
mode | the given WifiMode |
maxAllowedBandWidth | the maximum allowed TX bandwidth |
Definition at line 1123 of file wifi-phy.cc.
References GetChannelWidth(), ns3::GetMaximumChannelWidth(), ns3::WifiMode::GetModulationClass(), ns3::WIFI_MOD_CLASS_DSSS, and ns3::WIFI_MOD_CLASS_HR_DSSS.
Referenced by ns3::IdealWifiManager::DoGetDataTxVector(), ns3::MinstrelHtWifiManager::DoGetDataTxVector(), ns3::WifiRemoteStationManager::GetAckTxVector(), ns3::WifiRemoteStationManager::GetBlockAckTxVector(), ns3::WifiRemoteStationManager::GetCtsToSelfTxVector(), ns3::WifiRemoteStationManager::GetCtsTxVector(), ns3::WifiRemoteStationManager::GetDataTxVector(), and ns3::WifiRemoteStationManager::GetRtsTxVector().
dB_u ns3::WifiPhy::GetTxGain | ( | ) | const |
Return the transmission gain.
Definition at line 609 of file wifi-phy.cc.
References m_txGain.
Referenced by GetTypeId(), ns3::HePhy::StartTx(), ns3::PhyEntity::StartTx(), and ns3::YansWifiPhy::StartTx().
|
pure virtual |
This method is only relevant for SpectrumWifiPhy.
Implemented in ns3::SpectrumWifiPhy, and ns3::YansWifiPhy.
Referenced by ns3::PhyEntity::GetTxMaskRejectionParams().
dBm_u ns3::WifiPhy::GetTxPowerEnd | ( | ) | const |
Return the maximum available transmission power level.
Definition at line 583 of file wifi-phy.cc.
References m_txPowerEnd.
Referenced by GetTypeId().
Compute the transmit power for the next transmission.
The returned power will satisfy the power density constraints after addition of antenna gain.
ppdu | the PPDU to transmit |
Definition at line 2302 of file wifi-phy.cc.
References NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::RatioToDb().
Referenced by ns3::HePhy::StartTx(), ns3::PhyEntity::StartTx(), and ns3::YansWifiPhy::StartTx().
dBm_u ns3::WifiPhy::GetTxPowerStart | ( | ) | const |
Return the minimum available transmission power level.
Definition at line 570 of file wifi-phy.cc.
References m_txPowerBase.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 60 of file wifi-phy.cc.
References ns3::TypeId::ATTR_GET, GetCcaEdThreshold(), GetCcaSensitivityThreshold(), GetChannel(), GetChannelNumber(), GetChannelWidth(), GetFrequency(), GetMaxSupportedRxSpatialStreams(), GetMaxSupportedTxSpatialStreams(), GetNumberOfAntennas(), GetPrimary20Index(), GetRxGain(), GetRxSensitivity(), GetShortPhyPreambleSupported(), GetTxGain(), GetTxPowerEnd(), GetTxPowerStart(), HasFixedPhyBand(), m_channelSwitchDelay, m_frameCaptureModel, m_interference, m_notifyRxMacHeaderEnd, m_nTxPower, m_phyMonitorSniffRxTrace, m_phyMonitorSniffTxTrace, m_phyRxBeginTrace, m_phyRxDropTrace, m_phyRxEndTrace, m_phyRxMacHeaderEndTrace, m_phyRxPayloadBeginTrace, m_phyRxPpduDropTrace, m_phyTxBeginTrace, m_phyTxDropTrace, m_phyTxEndTrace, m_phyTxPsduBeginTrace, m_pifs, m_postReceptionErrorModel, m_powerDensityLimit, m_preambleDetectionModel, m_sifs, m_signalTransmissionCb, m_slot, m_state, ns3::MakeAttributeContainerAccessor(), ns3::MakeAttributeContainerChecker(), ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeEnumChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeTupleChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::MicroSeconds(), ns3::Seconds(), SetCcaEdThreshold(), SetCcaSensitivityThreshold(), SetFixedPhyBand(), SetMaxSupportedRxSpatialStreams(), SetMaxSupportedTxSpatialStreams(), SetNumberOfAntennas(), SetOperatingChannel(), ns3::TypeId::SetParent(), SetRxGain(), SetRxNoiseFigure(), SetRxSensitivity(), SetShortPhyPreambleSupported(), SetTxGain(), SetTxPowerEnd(), SetTxPowerStart(), ns3::WIFI_PHY_BAND_2_4GHZ, ns3::WIFI_PHY_BAND_5GHZ, ns3::WIFI_PHY_BAND_6GHZ, and ns3::WIFI_PHY_BAND_UNSPECIFIED.
|
static |
Get a WifiConstPsduMap from a PSDU and the TXVECTOR to use to send the PSDU.
The STA-ID value is properly determined based on whether the given PSDU has to be transmitted as a DL or UL frame.
psdu | the given PSDU |
txVector | the TXVECTOR to use to send the PSDU |
Definition at line 1801 of file wifi-phy.cc.
References ns3::WifiTxVector::GetModulationClass().
bool ns3::WifiPhy::HasFixedPhyBand | ( | ) | const |
Definition at line 1117 of file wifi-phy.cc.
References m_fixedPhyBand.
Referenced by GetTypeId().
bool ns3::WifiPhy::IsMcsSupported | ( | WifiModulationClass | modulation, |
uint8_t | mcs ) const |
Check if the given MCS of the given modulation class is supported by the PHY.
modulation | the modulation class |
mcs | the MCS value |
Definition at line 2053 of file wifi-phy.cc.
bool ns3::WifiPhy::IsModeSupported | ( | WifiMode | mode | ) | const |
Check if the given WifiMode is supported by the PHY.
mode | the wifi mode to check |
Definition at line 2024 of file wifi-phy.cc.
bool ns3::WifiPhy::IsReceivingPhyHeader | ( | ) | const |
Definition at line 2001 of file wifi-phy.cc.
Referenced by ns3::EhtFrameExchangeManager::TxopEnd().
bool ns3::WifiPhy::IsStateCcaBusy | ( | ) | const |
Definition at line 2155 of file wifi-phy.cc.
bool ns3::WifiPhy::IsStateIdle | ( | ) | const |
Definition at line 2161 of file wifi-phy.cc.
bool ns3::WifiPhy::IsStateOff | ( | ) | const |
Definition at line 2191 of file wifi-phy.cc.
Referenced by ns3::PhyEntity::DropPreambleEvent().
bool ns3::WifiPhy::IsStateRx | ( | ) | const |
Definition at line 2167 of file wifi-phy.cc.
Referenced by ns3::PhyEntity::EndPreambleDetectionPeriod(), and ns3::PhyEntity::ResetReceive().
bool ns3::WifiPhy::IsStateSleep | ( | ) | const |
Definition at line 2185 of file wifi-phy.cc.
Referenced by ns3::PhyEntity::DropPreambleEvent().
bool ns3::WifiPhy::IsStateSwitching | ( | ) | const |
Definition at line 2179 of file wifi-phy.cc.
bool ns3::WifiPhy::IsStateTx | ( | ) | const |
Definition at line 2173 of file wifi-phy.cc.
Notify PHY state helper to switch to CCA busy state,.
ppdu | the incoming PPDU or nullptr for any signal |
duration | the duration of the CCA state |
Definition at line 2222 of file wifi-phy.cc.
References NS_LOG_FUNCTION, and ns3::WIFI_CHANLIST_PRIMARY.
Referenced by ns3::PhyEntity::EndPreambleDetectionPeriod(), ns3::PhyEntity::EndReceiveField(), and ns3::PhyEntity::StartReceiveField().
void ns3::WifiPhy::NotifyChannelAccessRequested | ( | ) |
Notify the PHY that an access to the channel was requested.
This is typically called by the channel access manager to to notify the PHY about an ongoing transmission. The PHY will use this information to determine whether it should use power restriction as imposed by OBSS_PD SR.
Definition at line 2017 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::ChannelAccessManager::RequestAccess().
void ns3::WifiPhy::NotifyMonitorSniffRx | ( | Ptr< const WifiPsdu > | psdu, |
MHz_u | channelFreq, | ||
const WifiTxVector & | txVector, | ||
SignalNoiseDbm | signalNoise, | ||
const std::vector< bool > & | statusPerMpdu, | ||
uint16_t | staId = SU_STA_ID ) |
Public method used to fire a MonitorSniffer trace for a wifi PSDU being received.
Implemented for encapsulation purposes. This method will extract all MPDUs if packet is an A-MPDU and will fire tracedCallback. The A-MPDU reference number (RX side) is set within the method. It must be a different value for each A-MPDU but the same for each subframe within one A-MPDU.
psdu | the PSDU being received |
channelFreq | the frequency at which the packet is received. Note that in real devices this is normally the frequency to which the receiver is tuned, and this can be different than the frequency at which the packet was originally transmitted. This is because it is possible to have the receiver tuned on a given channel and still to be able to receive packets on a nearby channel. |
txVector | the TXVECTOR that holds RX parameters |
signalNoise | signal power and noise power in dBm (noise power includes the noise figure) |
statusPerMpdu | reception status per MPDU |
staId | the STA-ID |
Definition at line 1707 of file wifi-phy.cc.
References ns3::FIRST_MPDU_IN_AGGREGATE, ns3::WifiTxVector::IsAggregation(), ns3::LAST_MPDU_IN_AGGREGATE, ns3::MIDDLE_MPDU_IN_AGGREGATE, ns3::MpduInfo::mpduRefNumber, ns3::NORMAL_MPDU, NS_ASSERT_MSG, ns3::SINGLE_MPDU, and ns3::MpduInfo::type.
Referenced by ns3::PhyEntity::EndReceivePayload().
void ns3::WifiPhy::NotifyMonitorSniffTx | ( | Ptr< const WifiPsdu > | psdu, |
MHz_u | channelFreq, | ||
const WifiTxVector & | txVector, | ||
uint16_t | staId = SU_STA_ID ) |
Public method used to fire a MonitorSniffer trace for a wifi PSDU being transmitted.
Implemented for encapsulation purposes. This method will extract all MPDUs if packet is an A-MPDU and will fire tracedCallback. The A-MPDU reference number (RX side) is set within the method. It must be a different value for each A-MPDU but the same for each subframe within one A-MPDU.
psdu | the PSDU being received |
channelFreq | the frequency at which the packet is transmitted. |
txVector | the TXVECTOR that holds TX parameters |
staId | the STA-ID |
Definition at line 1761 of file wifi-phy.cc.
References ns3::FIRST_MPDU_IN_AGGREGATE, ns3::WifiTxVector::IsAggregation(), ns3::LAST_MPDU_IN_AGGREGATE, ns3::MIDDLE_MPDU_IN_AGGREGATE, ns3::MpduInfo::mpduRefNumber, ns3::NORMAL_MPDU, NS_ASSERT_MSG, ns3::SINGLE_MPDU, and ns3::MpduInfo::type.
void ns3::WifiPhy::NotifyRxBegin | ( | Ptr< const WifiPsdu > | psdu, |
const RxPowerWattPerChannelBand & | rxPowersW ) |
Public method used to fire a PhyRxBegin trace.
Implemented for encapsulation purposes.
psdu | the PSDU being transmitted |
rxPowersW | the receive power per channel band in Watts |
Definition at line 1664 of file wifi-phy.cc.
References ns3::PeekPointer().
Referenced by ns3::PhyEntity::EndPreambleDetectionPeriod().
void ns3::WifiPhy::NotifyRxDrop | ( | Ptr< const WifiPsdu > | psdu, |
WifiPhyRxfailureReason | reason ) |
Public method used to fire a PhyRxDrop trace.
Implemented for encapsulation purposes.
psdu | the PSDU being transmitted |
reason | the reason the packet was dropped |
Definition at line 1688 of file wifi-phy.cc.
References ns3::PeekPointer().
Public method used to fire a PhyRxEnd trace.
Implemented for encapsulation purposes.
psdu | the PSDU being transmitted |
Definition at line 1676 of file wifi-phy.cc.
References ns3::PeekPointer().
Referenced by ns3::PhyEntity::EndReceivePayload().
void ns3::WifiPhy::NotifyRxPpduDrop | ( | Ptr< const WifiPpdu > | ppdu, |
WifiPhyRxfailureReason | reason ) |
Public method used to fire a PhyRxPpduDrop trace.
Implemented for encapsulation purposes. This method also calls the PhyRxDrop trace.
ppdu | the PSDU being transmitted |
reason | the reason the packet was dropped |
Definition at line 1700 of file wifi-phy.cc.
Referenced by ns3::PhyEntity::DropPreambleEvent(), ns3::PhyEntity::EndPreambleDetectionPeriod(), ns3::PhyEntity::EndReceiveField(), ns3::HePhy::HandleRxPpduWithSameContent(), and ns3::PhyEntity::HandleRxPpduWithSameContent().
void ns3::WifiPhy::NotifyTxBegin | ( | const WifiConstPsduMap & | psdus, |
Watt_u | txPower ) |
Public method used to fire a PhyTxBegin trace.
Implemented for encapsulation purposes.
psdus | the PSDUs being transmitted (only one unless DL MU transmission) |
txPower | the transmit power |
Definition at line 1622 of file wifi-phy.cc.
References ns3::PeekPointer().
Public method used to fire a PhyTxDrop trace.
Implemented for encapsulation purposes.
psdu | the PSDU being transmitted |
Definition at line 1652 of file wifi-phy.cc.
References ns3::PeekPointer().
void ns3::WifiPhy::NotifyTxEnd | ( | const WifiConstPsduMap & | psdus | ) |
Public method used to fire a PhyTxEnd trace.
Implemented for encapsulation purposes.
psdus | the PSDUs being transmitted (only one unless DL MU transmission) |
Definition at line 1637 of file wifi-phy.cc.
References ns3::PeekPointer().
|
private |
Add the given MCS to the device MCS set.
mode | the MCS to add to the device MCS set |
|
private |
Rebuild the mapping of MCS values to indices in the device MCS set.
void ns3::WifiPhy::RegisterListener | ( | const std::shared_ptr< WifiPhyListener > & | listener | ) |
listener | the new listener |
Add the input listener to the list of objects to be notified of PHY-level events. The input listener is notified of CCA busy information.
Definition at line 490 of file wifi-phy.cc.
References ns3::Object::IsInitialized(), m_state, and SwitchMaybeToCcaBusy().
Referenced by TestUlOfdmaPhyTransmission::DoSetup().
|
protected |
Reset data upon end of TX or RX.
Definition at line 1954 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
Referenced by DoDispose(), ns3::PhyEntity::ErasePreambleEvent(), GetDelayUntilChannelSwitch(), and ns3::PhyEntity::NotifyInterferenceRxEndAndClear().
void ns3::WifiPhy::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.
powerRestricted | flag whether the transmit power is restricted for the next transmission |
txPowerMaxSiso | the SISO transmit power restriction for the next transmission |
txPowerMaxMimo | the MIMO transmit power restriction for the next transmission |
Definition at line 2279 of file wifi-phy.cc.
References NS_ASSERT, NS_LOG_FUNCTION, and ns3::OBSS_PD_CCA_RESET.
void ns3::WifiPhy::ResumeFromOff | ( | ) |
Resume from off mode.
Definition at line 1500 of file wifi-phy.cc.
References NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Referenced by ns3::WifiRadioEnergyModelHelper::DoInstall().
void ns3::WifiPhy::ResumeFromSleep | ( | ) |
Resume from sleep mode.
Definition at line 1473 of file wifi-phy.cc.
References NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
void ns3::WifiPhy::Send | ( | const WifiConstPsduMap & | psdus, |
const WifiTxVector & | txVector ) |
psdus | the PSDUs to send |
txVector | the TXVECTOR that has tx parameters such as mode, the transmission mode to use to send this PSDU, and txPowerLevel, a power level to use to send the whole PPDU. The real transmission power is calculated as txPowerMin + txPowerLevel * (txPowerMax - txPowerMin) / nTxLevels |
Definition at line 1814 of file wifi-phy.cc.
References ns3::DbmToW(), ns3::WifiTxVector::GetModulationClass(), ns3::WifiTxVector::GetNss(), ns3::WifiTxVector::GetNssMax(), ns3::WifiTxVector::GetNssTotal(), ns3::WifiTxVector::GetTxPowerLevel(), ns3::WifiTxVector::IsDlMuMimo(), ns3::WifiTxVector::IsMu(), ns3::WifiTxVector::IsValid(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RECEPTION_ABORTED_BY_TX, and ns3::SIGNAL_DETECTION_ABORTED_BY_TX.
void ns3::WifiPhy::Send | ( | Ptr< const WifiPsdu > | psdu, |
const WifiTxVector & | txVector ) |
This function is a wrapper for the Send variant that accepts a WifiConstPsduMap as first argument.
This function inserts the given PSDU in a WifiConstPsduMap along with a STA-ID value that is determined based on whether the given PSDU has to be transmitted as a DL or UL frame.
psdu | the PSDU to send (in a SU PPDU) |
txVector | the TXVECTOR that has TX parameters such as mode, the transmission mode to use to send this PSDU, and txPowerLevel, a power level to use to send the whole PPDU. The real transmission power is calculated as txPowerMin + txPowerLevel * (txPowerMax - txPowerMin) / nTxLevels |
Definition at line 1807 of file wifi-phy.cc.
References NS_LOG_FUNCTION, and Send().
Referenced by ns3::FrameExchangeManager::ForwardMpduDown(), ns3::HtFrameExchangeManager::ForwardPsduDown(), PsrExperiment::Send(), TestUlOfdmaPpduUid::SendMuPpdu(), SpectrumWifiPhyFilterTest::SendPpdu(), TestUlOfdmaPpduUid::SendSuPpdu(), and TestUlOfdmaPpduUid::SendTbPpdu().
void ns3::WifiPhy::SetCapabilitiesChangedCallback | ( | Callback< void > | callback | ) |
callback | the callback to invoke when PHY capabilities have changed. |
Definition at line 507 of file wifi-phy.cc.
References m_capabilitiesChangedCallback.
void ns3::WifiPhy::SetCcaEdThreshold | ( | dBm_u | threshold | ) |
Sets the CCA energy detection threshold.
The energy of a all received signals should be higher than this threshold to allow the PHY layer to declare CCA BUSY state.
threshold | the CCA threshold |
Definition at line 526 of file wifi-phy.cc.
References m_ccaEdThreshold, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetCcaSensitivityThreshold | ( | dBm_u | threshold | ) |
Sets the CCA sensitivity threshold.
The energy of a received wifi signal should be higher than this threshold to allow the PHY layer to declare CCA BUSY state.
threshold | the CCA sensitivity threshold |
Definition at line 539 of file wifi-phy.cc.
References m_ccaSensitivityThreshold, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
virtual |
Sets the device this PHY is associated with.
device | the device this PHY is associated with |
Reimplemented in ns3::SpectrumWifiPhy.
Definition at line 641 of file wifi-phy.cc.
References m_device.
Referenced by Bug2831TestCase::DoRun(), TestWifiPhyRxTraceHelperYans::DoSetup(), and ns3::SpectrumWifiPhy::SetDevice().
void ns3::WifiPhy::SetErrorRateModel | ( | const Ptr< ErrorRateModel > | model | ) |
Sets the error rate model.
model | the error rate model |
Definition at line 687 of file wifi-phy.cc.
References m_interference, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by Bug2831TestCase::DoRun(), SpectrumWifiPhyFilterTest::DoSetup(), SpectrumWifiPhyTrackedBandsTest::DoSetup(), TestDlMuMimoPhyTransmission::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), TestUlOfdmaPpduUid::DoSetup(), and TestWifiPhyRxTraceHelperYans::DoSetup().
void ns3::WifiPhy::SetFixedPhyBand | ( | bool | enable | ) |
Configure whether it is prohibited to change PHY band after initialization.
enable | true to prohibit changing PHY band after initialization, false otherwise |
Definition at line 1111 of file wifi-phy.cc.
References m_fixedPhyBand.
Referenced by GetTypeId().
void ns3::WifiPhy::SetFrameCaptureModel | ( | const Ptr< FrameCaptureModel > | frameCaptureModel | ) |
Sets the frame capture model.
frameCaptureModel | the frame capture model |
Definition at line 702 of file wifi-phy.cc.
References m_frameCaptureModel.
|
virtual |
Sets the interference helper.
helper | the interference helper |
Reimplemented in ns3::YansWifiPhy.
Definition at line 678 of file wifi-phy.cc.
References ns3::DbToRatio(), m_interference, m_noiseFigure, m_numberOfAntennas, and NS_LOG_FUNCTION.
Referenced by SpectrumWifiPhyFilterTest::DoSetup(), SpectrumWifiPhyTrackedBandsTest::DoSetup(), TestDlMuMimoPhyTransmission::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), TestUlOfdmaPpduUid::DoSetup(), and ns3::YansWifiPhy::SetInterferenceHelper().
void ns3::WifiPhy::SetMaxModulationClassSupported | ( | WifiModulationClass | modClass | ) |
Set the maximum modulation class that has to be supported by this PHY object.
The maximum modulation class supported will be the minimum between the given modulation class and the maximum modulation class supported based on the configured standard.
modClass | the given modulation class |
Definition at line 996 of file wifi-phy.cc.
References m_maxModClassSupported, and NS_LOG_FUNCTION.
void ns3::WifiPhy::SetMaxSupportedRxSpatialStreams | ( | uint8_t | streams | ) |
streams | the maximum number of supported RX spatial streams. |
Definition at line 1384 of file wifi-phy.cc.
References NS_ASSERT.
Referenced by GetTypeId().
void ns3::WifiPhy::SetMaxSupportedTxSpatialStreams | ( | uint8_t | streams | ) |
streams | the maximum number of supported TX spatial streams. |
Definition at line 1352 of file wifi-phy.cc.
References NS_ASSERT, and ns3::WIFI_MOD_CLASS_HT.
Referenced by GetTypeId().
void ns3::WifiPhy::SetMobility | ( | const Ptr< MobilityModel > | mobility | ) |
assign a mobility model to this device
This method allows a user to specify a mobility model that should be associated with this physical layer. Calling this method is optional and only necessary if the user wants to override the mobility model that is aggregated to the node.
mobility | the mobility model this PHY is associated with |
Definition at line 653 of file wifi-phy.cc.
References m_mobility.
Referenced by Bug2831TestCase::DoRun(), SpectrumWifiPhyFilterTest::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), and TestUlOfdmaPpduUid::DoSetup().
void ns3::WifiPhy::SetNTxPower | ( | uint8_t | n | ) |
Sets the number of transmission power levels available between the minimum level and the maximum level.
Transmission power levels are equally separated (in dBm) with the minimum and the maximum included.
n | the number of available levels |
Definition at line 589 of file wifi-phy.cc.
References m_nTxPower, and NS_LOG_FUNCTION.
void ns3::WifiPhy::SetNumberOfAntennas | ( | uint8_t | antennas | ) |
antennas | the number of antennas on this node. |
Definition at line 1334 of file wifi-phy.cc.
References NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetOffMode | ( | ) |
Put in off mode.
Definition at line 1463 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::WifiRadioEnergyModelHelper::DoInstall(), and ns3::StaWifiMac::ReceiveAssocResp().
void ns3::WifiPhy::SetOperatingChannel | ( | const ChannelSegments & | channelSegments | ) |
This overloaded function is used to pass a list of segments from which the operating channel can be deduced.
channelSegments | the segments identifying the operating channel |
Definition at line 1156 of file wifi-phy.cc.
References DoChannelSwitch(), GetDelayUntilChannelSwitch(), ns3::Object::IsInitialized(), m_channelSettings, m_standard, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), SetOperatingChannel(), and ns3::WIFI_STANDARD_UNSPECIFIED.
void ns3::WifiPhy::SetOperatingChannel | ( | const ChannelTuple & | tuple | ) |
This overloaded function is used when the operating channel consists of a single segment, identified by a tuple.
tuple | the segment identifying the operating channel |
Definition at line 1150 of file wifi-phy.cc.
References SetOperatingChannel().
void ns3::WifiPhy::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.
Otherwise, check if a channel switch can be performed now. If not, schedule another call to this method when channel switch can be performed. Otherwise, set the given operating channel and call ConfigureStandard if the PHY band has changed.
Note that, in case a Spectrum PHY is used, a spectrum channel covering the operating channel bandwidth must have been already added when actually setting the operating channel.
channel | the given operating channel |
Definition at line 1135 of file wifi-phy.cc.
References NS_LOG_FUNCTION, and SetOperatingChannel().
Referenced by Bug2831TestCase::ChangeSupportedChannelWidth(), ConfigureStandard(), Bug2831TestCase::DoRun(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlOfdmaPpduUid::DoSetup(), TestWifiPhyRxTraceHelperYans::DoSetup(), GetTypeId(), SpectrumWifiPhyFilterTest::RunOne(), TestDlMuMimoPhyTransmission::RunOne(), TestDlOfdmaPhyPuncturing::RunOne(), TestDlOfdmaPhyTransmission::RunOne(), TestUlMuMimoPhyTransmission::RunOne(), TestUlOfdmaPhyTransmission::RunOne(), SetOperatingChannel(), SetOperatingChannel(), SetOperatingChannel(), SpectrumWifiPhyTrackedBandsTest::SwitchChannel(), and ns3::MeshWifiInterfaceMac::SwitchFrequencyChannel().
void ns3::WifiPhy::SetPhyId | ( | uint8_t | phyId | ) |
Set the index allocated to this PHY.
phyId | the ID allocated to this PHY |
Definition at line 665 of file wifi-phy.cc.
References m_phyId, and NS_LOG_FUNCTION.
void ns3::WifiPhy::SetPifs | ( | Time | pifs | ) |
Set the PCF Interframe Space (PIFS) for this PHY.
pifs | the PIFS duration |
Definition at line 847 of file wifi-phy.cc.
References m_pifs.
Referenced by Configure80211a(), Configure80211b(), and Configure80211p().
void ns3::WifiPhy::SetPostReceptionErrorModel | ( | const Ptr< ErrorModel > | em | ) |
Attach a receive ErrorModel to the WifiPhy.
The WifiPhy may optionally include an ErrorModel in the packet receive chain. The error model is additive to any modulation-based error model based on SNR, and is typically used to force specific packet losses or for testing purposes.
em | Pointer to the ErrorModel. |
Definition at line 695 of file wifi-phy.cc.
References m_postReceptionErrorModel, and NS_LOG_FUNCTION.
void ns3::WifiPhy::SetPreambleDetectionModel | ( | const Ptr< PreambleDetectionModel > | preambleDetectionModel | ) |
Sets the preamble detection model.
preambleDetectionModel | the preamble detection model |
Definition at line 708 of file wifi-phy.cc.
References m_preambleDetectionModel.
Referenced by TestMultipleHeTbPreambles::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), and TestWifiPhyRxTraceHelperYans::DoSetup().
void ns3::WifiPhy::SetPreviouslyRxPpduUid | ( | uint64_t | uid | ) |
Set the UID of the previously received PPDU.
uid | the value for the UID of the previously received PPDU |
Definition at line 1947 of file wifi-phy.cc.
References NS_ASSERT, and ns3::WIFI_STANDARD_80211be.
void ns3::WifiPhy::SetReceiveErrorCallback | ( | RxErrorCallback | callback | ) |
callback | the callback to invoke upon erroneous packet reception. |
Definition at line 484 of file wifi-phy.cc.
References m_state.
Referenced by TestDlMuMimoPhyTransmission::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), ns3::FrameExchangeManager::ResetPhy(), and ns3::FrameExchangeManager::SetWifiPhy().
void ns3::WifiPhy::SetReceiveOkCallback | ( | RxOkCallback | callback | ) |
callback | the callback to invoke upon successful packet reception. |
Definition at line 478 of file wifi-phy.cc.
References m_state.
Referenced by WifiPrimaryChannelsTest::DoRun(), TestDlMuMimoPhyTransmission::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestMultipleCtsResponsesFromMuRts::DoSetup(), TestPhyPaddingExclusion::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), ns3::FrameExchangeManager::ResetPhy(), and ns3::FrameExchangeManager::SetWifiPhy().
void ns3::WifiPhy::SetRxGain | ( | dB_u | gain | ) |
Sets the reception gain.
gain | the reception gain |
Definition at line 615 of file wifi-phy.cc.
References m_rxGain, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetRxNoiseFigure | ( | dB_u | noiseFigure | ) |
Sets the RX loss in the Signal-to-Noise-Ratio due to non-idealities in the receiver.
noiseFigure | noise figure |
Definition at line 552 of file wifi-phy.cc.
References ns3::DbToRatio(), m_interference, m_noiseFigure, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetRxSensitivity | ( | dBm_u | threshold | ) |
Sets the receive sensitivity threshold.
The energy of a received signal should be higher than this threshold to allow the PHY layer to detect the signal.
threshold | the receive sensitivity threshold |
Definition at line 513 of file wifi-phy.cc.
References m_rxSensitivity, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetShortPhyPreambleSupported | ( | bool | preamble | ) |
Enable or disable short PHY preamble.
preamble | sets whether short PHY preamble is supported or not |
Definition at line 628 of file wifi-phy.cc.
References m_shortPreamble, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetSifs | ( | Time | sifs | ) |
Set the Short Interframe Space (SIFS) for this PHY.
sifs | the SIFS duration |
Definition at line 823 of file wifi-phy.cc.
References m_sifs.
Referenced by Configure80211a(), Configure80211b(), and Configure80211p().
void ns3::WifiPhy::SetSleepMode | ( | bool | forceSleepWhileInRx = false | ) |
Put in sleep mode.
forceSleepWhileInRx | force setting sleep mode if state is RX |
Definition at line 1417 of file wifi-phy.cc.
References NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
void ns3::WifiPhy::SetSlot | ( | Time | slot | ) |
Set the slot duration for this PHY.
slot | the slot duration |
Definition at line 835 of file wifi-phy.cc.
References m_slot.
Referenced by Configure80211a(), Configure80211b(), Configure80211p(), ns3::ApWifiMac::SendOneBeacon(), and ns3::StaWifiMac::UpdateApInfo().
void ns3::WifiPhy::SetTxGain | ( | dB_u | gain | ) |
Sets the transmission gain.
gain | the transmission gain |
Definition at line 602 of file wifi-phy.cc.
References m_txGain, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
void ns3::WifiPhy::SetTxPowerEnd | ( | dBm_u | end | ) |
Sets the maximum available transmission power level.
end | the maximum transmission power level |
Definition at line 576 of file wifi-phy.cc.
References m_txPowerEnd, and NS_LOG_FUNCTION.
Referenced by TestWifiPhyRxTraceHelperYans::DoSetup(), and GetTypeId().
void ns3::WifiPhy::SetTxPowerStart | ( | dBm_u | start | ) |
Sets the minimum available transmission power level.
start | the minimum transmission power level |
Definition at line 563 of file wifi-phy.cc.
References m_txPowerBase, and NS_LOG_FUNCTION.
Referenced by TestWifiPhyRxTraceHelperYans::DoSetup(), and GetTypeId().
void ns3::WifiPhy::SetWifiRadioEnergyModel | ( | const Ptr< WifiRadioEnergyModel > | wifiRadioEnergyModel | ) |
Sets the wifi radio energy model.
wifiRadioEnergyModel | the wifi radio energy model |
Definition at line 714 of file wifi-phy.cc.
References m_wifiRadioEnergyModel.
void ns3::WifiPhy::StartReceivePreamble | ( | Ptr< const WifiPpdu > | ppdu, |
RxPowerWattPerChannelBand & | rxPowersW, | ||
Time | rxDuration ) |
Start receiving the PHY preamble of a PPDU (i.e.
the first bit of the preamble has arrived).
ppdu | the arriving PPDU |
rxPowersW | the receive power in W per band |
rxDuration | the duration of the PPDU |
Definition at line 1978 of file wifi-phy.cc.
References NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::WIFI_MOD_CLASS_UNKNOWN.
Referenced by ns3::SpectrumWifiPhy::StartRx().
ppdu | the PPDU to send |
Implemented in ns3::SpectrumWifiPhy, ns3::YansWifiPhy, and OfdmaSpectrumWifiPhy.
Check if PHY state should move to CCA busy state based on current state of interference tracker.
ppdu | the incoming PPDU or nullptr for any signal |
Definition at line 2215 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
Referenced by ns3::PhyEntity::DropPreambleEvent(), ns3::PhyEntity::EndReceiveField(), ns3::PhyEntity::EndReceivePayload(), ns3::PhyEntity::ErasePreambleEvent(), ns3::SpectrumWifiPhy::FinalizeChannelSwitch(), RegisterListener(), ns3::PhyEntity::ResetReceive(), ns3::PhyEntity::StartReceivePreamble(), and ns3::SpectrumWifiPhy::StartRx().
|
private |
Callback function when a transmission is completed.
psdus | the PSDUs that have been sent |
Definition at line 1931 of file wifi-phy.cc.
References NS_LOG_FUNCTION.
void ns3::WifiPhy::UnregisterListener | ( | const std::shared_ptr< WifiPhyListener > & | listener | ) |
listener | the listener to be unregistered |
Remove the input listener from the list of objects to be notified of PHY-level events.
Definition at line 501 of file wifi-phy.cc.
References m_state.
|
friend |
Definition at line 57 of file wifi-phy.h.
|
private |
estimated Ack TX time
Definition at line 1595 of file wifi-phy.h.
Referenced by Configure80211a(), Configure80211b(), Configure80211p(), and GetAckTxTime().
|
private |
WifiPhyBand.
Definition at line 1587 of file wifi-phy.h.
Referenced by Configure80211ax(), Configure80211n(), DoChannelSwitch(), and GetPhyBand().
|
private |
estimated BlockAck TX time
Definition at line 1596 of file wifi-phy.h.
Referenced by Configure80211n(), and GetBlockAckTxTime().
|
private |
Callback when PHY capabilities changed.
Definition at line 1635 of file wifi-phy.h.
Referenced by SetCapabilitiesChangedCallback().
|
private |
Clear channel assessment (CCA) energy detection (ED) threshold.
Definition at line 1599 of file wifi-phy.h.
Referenced by GetCcaEdThreshold(), and SetCcaEdThreshold().
|
private |
Clear channel assessment (CCA) modulation and coding rate sensitivity threshold.
Definition at line 1600 of file wifi-phy.h.
Referenced by GetCcaSensitivityThreshold(), and SetCcaSensitivityThreshold().
|
private |
Flag if channels access has been requested (used for OBSS_PD SR)
Definition at line 1613 of file wifi-phy.h.
Referenced by DoChannelSwitch().
|
private |
Store operating channel settings until initialization.
Definition at line 1588 of file wifi-phy.h.
Referenced by ConfigureStandard(), DoChannelSwitch(), and SetOperatingChannel().
|
private |
Time required to switch between channel.
Definition at line 1623 of file wifi-phy.h.
Referenced by GetChannelSwitchDelay(), and GetTypeId().
Hold the current event.
Definition at line 1337 of file wifi-phy.h.
Referenced by ns3::PhyEntity::DoAbortCurrentReception(), ns3::PhyEntity::DoEndReceivePayload(), ns3::PhyEntity::EndPreambleDetectionPeriod(), MuMimoSpectrumWifiPhy::GetCurrentEvent(), ns3::PhyEntity::GetCurrentEvent(), OfdmaSpectrumWifiPhy::GetCurrentEvent(), ns3::PhyEntity::ResetReceive(), and ns3::PhyEntity::StartReceivePreamble().
|
protected |
store event associated to a PPDU (that has a unique ID and preamble combination) whose preamble is being received
Definition at line 1339 of file wifi-phy.h.
Referenced by ns3::PhyEntity::AddPreambleEvent(), ns3::PhyEntity::DoEndReceivePayload(), ns3::PhyEntity::DoEndReceivePreamble(), ns3::PhyEntity::DropPreambleEvent(), ns3::PhyEntity::EndPreambleDetectionPeriod(), ns3::PhyEntity::ErasePreambleEvent(), ns3::PhyEntity::GetCurrentPreambleEvents(), OfdmaSpectrumWifiPhy::GetCurrentPreambleEvents(), ns3::PhyEntity::ResetReceive(), and ns3::PhyEntity::StartReceivePreamble().
|
private |
Pointer to the device.
Definition at line 1625 of file wifi-phy.h.
Referenced by DoDispose(), DoInitialize(), GetDevice(), and SetDevice().
|
protected |
the end of PHY receive event
Definition at line 1334 of file wifi-phy.h.
Referenced by ns3::PhyEntity::EndPreambleDetectionPeriod(), ns3::PhyEntity::EndReceiveField(), ns3::PhyEntity::StartReceiveField(), and ns3::PhyEntity::StartReceivePayload().
|
protected |
the end of transmit event
Definition at line 1335 of file wifi-phy.h.
|
private |
True to prohibit changing PHY band after initialization.
Definition at line 1590 of file wifi-phy.h.
Referenced by DoChannelSwitch(), HasFixedPhyBand(), and SetFixedPhyBand().
|
private |
Frame capture model.
Definition at line 1628 of file wifi-phy.h.
Referenced by DoDispose(), GetTypeId(), SetFrameCaptureModel(), and ns3::PhyEntity::StartReceivePreamble().
|
protected |
Pointer to a helper responsible for interference computations.
Definition at line 1324 of file wifi-phy.h.
Referenced by CalculateSnr(), ns3::PhyEntity::CreateInterferenceEvent(), DoDispose(), ns3::PhyEntity::EndPreambleDetectionPeriod(), ns3::PhyEntity::EndReceivePayload(), ns3::PhyEntity::GetDelayUntilCcaEnd(), OfdmaSpectrumWifiPhy::GetEnergyDuration(), ns3::PhyEntity::GetPhyHeaderSnrPer(), ns3::PhyEntity::GetReceptionStatus(), GetTypeId(), ns3::PhyEntity::HandleRxPpduWithSameContent(), ns3::PhyEntity::NotifyInterferenceRxEndAndClear(), ns3::PhyEntity::ResetReceive(), ns3::PhyEntity::ScheduleEndOfMpdus(), SetErrorRateModel(), SetInterferenceHelper(), ns3::YansWifiPhy::SetInterferenceHelper(), SetRxNoiseFigure(), ns3::PhyEntity::StartPreambleDetectionPeriod(), ns3::SpectrumWifiPhy::StartRx(), and ns3::SpectrumWifiPhy::UpdateInterferenceHelperBands().
|
private |
max modulation class supported
Definition at line 1586 of file wifi-phy.h.
Referenced by ConfigureStandard(), GetMaxModulationClassSupported(), and SetMaxModulationClassSupported().
|
private |
Pointer to the mobility model.
Definition at line 1626 of file wifi-phy.h.
Referenced by DoDispose(), DoInitialize(), GetMobility(), and SetMobility().
|
private |
The noise figure.
Definition at line 1621 of file wifi-phy.h.
Referenced by SetInterferenceHelper(), and SetRxNoiseFigure().
|
private |
whether the PHY is capable of notifying MAC header RX end
Definition at line 1633 of file wifi-phy.h.
Referenced by GetTypeId(), and ns3::PhyEntity::ScheduleEndOfMpdus().
|
private |
Number of available transmission power levels.
Definition at line 1607 of file wifi-phy.h.
Referenced by GetNTxPower(), GetPower(), GetTypeId(), and SetNTxPower().
|
private |
Number of transmitters.
Definition at line 1617 of file wifi-phy.h.
Referenced by SetInterferenceHelper().
|
private |
Operating channel.
Definition at line 1589 of file wifi-phy.h.
Referenced by ConfigureStandard(), GetChannelNumber(), GetChannelWidth(), GetFrequency(), GetOperatingChannel(), and GetPrimary20Index().
|
protected |
This map holds the supported PHY entities.
The set of parameters (e.g. mode) that this WifiPhy(-derived class) can support can be obtained through it.
When it comes to modes, in conversation we call this set the DeviceRateSet (not a term you'll find in the standard), and it is a superset of standard-defined parameters such as the OperationalRateSet, and the BSSBasicRateSet (which, themselves, have a superset/subset relationship).
Mandatory rates relevant to this WifiPhy can be found by iterating over the elements of this map, for each modulation class, looking for WifiMode objects for which WifiMode::IsMandatory() is true.
Definition at line 1362 of file wifi-phy.h.
Referenced by AddPhyEntity(), ConfigureStandard(), DoDispose(), MuMimoSpectrumWifiPhy::DoInitialize(), MuRtsCtsSpectrumWifiPhy::DoInitialize(), OfdmaSpectrumWifiPhy::DoInitialize(), ns3::PhyEntity::EndPreambleDetectionPeriod(), GetPhyEntity(), and GetPhyEntityForPpdu().
|
protected |
the index of the PHY in the vector of PHYs held by the WifiNetDevice
Definition at line 1321 of file wifi-phy.h.
Referenced by GetPhyId(), and SetPhyId().
|
private |
A trace source that emulates a Wi-Fi device in monitor mode sniffing a packet being received.
As a reference with the real world, firing this trace corresponds in the madwifi driver to calling the function ieee80211_input_monitor()
Definition at line 1555 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
A trace source that emulates a Wi-Fi device in monitor mode sniffing a packet being transmitted.
As a reference with the real world, firing this trace corresponds in the madwifi driver to calling the function ieee80211_input_monitor()
Definition at line 1574 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when a packet begins the reception process from the medium.
Definition at line 1488 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when the PHY layer drops a packet it has received.
Definition at line 1530 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when a packet ends the reception process from the medium.
Definition at line 1523 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when the reception of a MAC header ends.
This traced callback models the behavior of real PHYs that are able to decode the MAC header of an MPDU being received and make the information therein available to the MAC as soon as the reception of the MAC header ends.
Definition at line 1515 of file wifi-phy.h.
Referenced by GetTypeId(), and ns3::PhyEntity::ScheduleEndOfMpdus().
|
private |
The trace source fired when the reception of the PHY payload (PSDU) begins.
This traced callback models the behavior of the PHY-RXSTART primitive which is launched upon correct decoding of the PHY header and support of modes within. We thus assume that it is sent just before starting the decoding of the payload, since it's there that support of the header's content is checked. In addition, it's also at that point that the correct decoding of HT-SIG, VHT-SIGs, and HE-SIGs are checked.
Definition at line 1504 of file wifi-phy.h.
Referenced by ns3::PhyEntity::DoStartReceivePayload(), ns3::PhyEntity::EndReceiveField(), GetTypeId(), and ns3::PhyEntity::NotifyPayloadBegin().
|
private |
The trace source fired when the PHY layer drops a packet it has received.
Definition at line 1535 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when a packet begins the transmission process on the medium.
Definition at line 1457 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when the PHY layer drops a packet as it tries to transmit it.
Definition at line 1480 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when a packet ends the transmission process on the medium.
Definition at line 1472 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
The trace source fired when a PSDU map begins the transmission process on the medium.
Definition at line 1464 of file wifi-phy.h.
Referenced by GetTypeId().
|
private |
PCF Interframe Space (PIFS) duration.
Definition at line 1594 of file wifi-phy.h.
Referenced by GetPifs(), GetTypeId(), and SetPifs().
|
private |
Error model for receive packet events.
Definition at line 1631 of file wifi-phy.h.
Referenced by DoDispose(), ns3::PhyEntity::GetReceptionStatus(), GetTypeId(), and SetPostReceptionErrorModel().
|
private |
|
private |
Flag whether transmit power is restricted by OBSS PD SR.
Definition at line 1610 of file wifi-phy.h.
Referenced by DoChannelSwitch().
|
private |
Preamble detection model.
Definition at line 1629 of file wifi-phy.h.
Referenced by DoDispose(), ns3::PhyEntity::EndPreambleDetectionPeriod(), GetTypeId(), and SetPreambleDetectionModel().
|
protected |
UID of the previously received PPDU, reset to UINT64_MAX upon transmission.
Definition at line 1342 of file wifi-phy.h.
Referenced by ns3::PhyEntity::EndReceivePayload(), MuMimoSpectrumWifiPhy::SetPpduUid(), MuRtsCtsSpectrumWifiPhy::SetPpduUid(), OfdmaSpectrumWifiPhy::SetPpduUid(), MuMimoSpectrumWifiPhy::SetTriggerFrameUid(), and OfdmaSpectrumWifiPhy::SetTriggerFrameUid().
|
protected |
Provides uniform random variables.
Definition at line 1326 of file wifi-phy.h.
Referenced by WifiPhy(), DoDispose(), and ns3::PhyEntity::GetRandomValue().
|
private |
Reception gain.
Definition at line 1604 of file wifi-phy.h.
Referenced by GetRxGain(), and SetRxGain().
|
protected |
A-MPDU reference number to identify all received subframes belonging to the same received A-MPDU.
Definition at line 1331 of file wifi-phy.h.
|
private |
Receive sensitivity threshold.
Definition at line 1598 of file wifi-phy.h.
Referenced by GetRxSensitivity(), and SetRxSensitivity().
|
private |
Number of supported RX spatial streams.
Definition at line 1619 of file wifi-phy.h.
|
private |
Flag if short PHY preamble is supported.
Definition at line 1616 of file wifi-phy.h.
Referenced by GetShortPhyPreambleSupported(), and SetShortPhyPreambleSupported().
|
private |
Short Interframe Space (SIFS) duration.
Definition at line 1592 of file wifi-phy.h.
Referenced by GetSifs(), GetTypeId(), and SetSifs().
|
protected |
Signal Transmission callback.
Definition at line 1365 of file wifi-phy.h.
Referenced by GetTypeId(), ns3::SpectrumWifiPhy::StartTx(), and ns3::YansWifiPhy::StartTx().
|
private |
Slot duration.
Definition at line 1593 of file wifi-phy.h.
Referenced by GetSlot(), GetTypeId(), and SetSlot().
|
private |
WifiStandard.
Definition at line 1585 of file wifi-phy.h.
Referenced by ConfigureStandard(), DoChannelSwitch(), GetLatestPhyEntity(), GetStandard(), and SetOperatingChannel().
|
protected |
Pointer to WifiPhyStateHelper.
Definition at line 1327 of file wifi-phy.h.
Referenced by WifiPhy(), DoDispose(), GetDelayUntilChannelSwitch(), GetState(), GetTypeId(), RegisterListener(), ns3::PhyEntity::SetOwner(), SetReceiveErrorCallback(), SetReceiveOkCallback(), and UnregisterListener().
|
private |
Record the time the last preamble was detected.
Definition at line 1632 of file wifi-phy.h.
Referenced by ns3::PhyEntity::EndPreambleDetectionPeriod(), and ns3::PhyEntity::StartReceivePreamble().
|
private |
Transmission gain.
Definition at line 1603 of file wifi-phy.h.
Referenced by GetTxGain(), and SetTxGain().
|
protected |
A-MPDU reference number to identify all transmitted subframes belonging to the same received A-MPDU.
Definition at line 1329 of file wifi-phy.h.
|
private |
Minimum transmission power.
Definition at line 1605 of file wifi-phy.h.
Referenced by GetPower(), GetTxPowerStart(), and SetTxPowerStart().
|
private |
Maximum transmission power.
Definition at line 1606 of file wifi-phy.h.
Referenced by GetPower(), GetTxPowerEnd(), and SetTxPowerEnd().
|
private |
MIMO maximum transmit power due to OBSS PD SR power restriction.
Definition at line 1612 of file wifi-phy.h.
|
private |
SISO maximum transmit power due to OBSS PD SR power restriction.
Definition at line 1611 of file wifi-phy.h.
|
private |
Number of supported TX spatial streams.
Definition at line 1618 of file wifi-phy.h.
Referenced by Configure80211n().
|
private |
Wifi radio energy model.
Definition at line 1630 of file wifi-phy.h.
Referenced by DoDispose(), and SetWifiRadioEnergyModel().