A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::WifiPhyStateHelper Class Reference

This objects implements the PHY state machine of the Wifi device. More...

#include "wifi-phy-state-helper.h"

+ Inheritance diagram for ns3::WifiPhyStateHelper:
+ Collaboration diagram for ns3::WifiPhyStateHelper:

Public Types

typedef void(* RxEndErrorTracedCallback) (Ptr< const Packet > packet, double snr)
 TracedCallback signature for receive end error event.
 
typedef void(* RxOkTracedCallback) (Ptr< const Packet > packet, double snr, WifiMode mode, WifiPreamble preamble)
 TracedCallback signature for receive end OK event.
 
typedef void(* StateTracedCallback) (Time start, Time duration, WifiPhyState state)
 TracedCallback signature for state changes.
 
typedef void(* TxTracedCallback) (Ptr< const Packet > packet, WifiMode mode, WifiPreamble preamble, uint8_t power)
 TracedCallback signature for transmit event.
 

Public Member Functions

 WifiPhyStateHelper ()
 
Time GetDelayUntilIdle () const
 Return the time before the state is back to IDLE.
 
Time GetLastRxEndTime () const
 Return the time the last RX end.
 
Time GetLastRxStartTime () const
 Return the time the last RX start.
 
WifiPhyState GetState () const
 Return the current state of WifiPhy.
 
bool IsStateCcaBusy () const
 Check whether the current state is CCA busy.
 
bool IsStateIdle () const
 Check whether the current state is IDLE.
 
bool IsStateOff () const
 Check whether the current state is OFF.
 
bool IsStateRx () const
 Check whether the current state is RX.
 
bool IsStateSleep () const
 Check whether the current state is SLEEP.
 
bool IsStateSwitching () const
 Check whether the current state is SWITCHING.
 
bool IsStateTx () const
 Check whether the current state is TX.
 
void NotifyRxMpdu (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector)
 Notify the reception of an MPDU included in an A-MPDU.
 
void NotifyRxPsduFailed (Ptr< const WifiPsdu > psdu, double snr)
 Handle the unsuccessful reception of a PSDU.
 
void NotifyRxPsduSucceeded (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector, uint16_t staId, const std::vector< bool > &statusPerMpdu)
 Handle the successful reception of a PSDU.
 
void RegisterListener (WifiPhyListener *listener)
 Register WifiPhyListener to this WifiPhyStateHelper.
 
void SetReceiveErrorCallback (RxErrorCallback callback)
 Set a callback for a failed reception.
 
void SetReceiveOkCallback (RxOkCallback callback)
 Set a callback for a successful reception.
 
void SwitchFromOff ()
 Switch from off mode.
 
void SwitchFromRxAbort (uint16_t operatingWidth)
 Abort current reception following a CCA reset request.
 
void SwitchFromRxEndError ()
 Switch from RX after the reception failed.
 
void SwitchFromRxEndOk ()
 Switch from RX after the reception was successful.
 
void SwitchFromSleep ()
 Switch from sleep mode.
 
void SwitchMaybeToCcaBusy (Time duration, WifiChannelListType channelType, const std::vector< Time > &per20MhzDurations)
 Switch to CCA busy.
 
void SwitchToChannelSwitching (Time switchingDuration)
 Switch state to channel switching for the given duration.
 
void SwitchToOff ()
 Switch to off mode.
 
void SwitchToRx (Time rxDuration)
 Switch state to RX for the given duration.
 
void SwitchToSleep ()
 Switch to sleep mode.
 
void SwitchToTx (Time txDuration, WifiConstPsduMap psdus, double txPowerDbm, const WifiTxVector &txVector)
 Switch state to TX for the given duration.
 
void UnregisterListener (WifiPhyListener *listener)
 Remove WifiPhyListener from this WifiPhyStateHelper.
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor.
 
 ~Object () override
 Destructor.
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together.
 
void Dispose ()
 Dispose of this Object.
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one.
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object.
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object.
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Private Types

typedef std::vector< WifiPhyListener * > Listeners
 typedef for a list of WifiPhyListeners
 

Private Member Functions

void DoSwitchFromRx ()
 Switch the state from RX.
 
void LogPreviousIdleAndCcaBusyStates ()
 Log the idle and CCA busy states.
 
void NotifyCcaBusyStart (Time duration, WifiChannelListType channelType, const std::vector< Time > &per20MhzDurations)
 Notify all WifiPhyListener that the CCA has started for the given duration.
 
void NotifyOff ()
 Notify all WifiPhyListener that we are going to switch off.
 
void NotifyOn ()
 Notify all WifiPhyListener that we are going to switch on.
 
void NotifyRxEndError ()
 Notify all WifiPhyListener that the reception was not successful.
 
void NotifyRxEndOk ()
 Notify all WifiPhyListener that the reception was successful.
 
void NotifyRxStart (Time duration)
 Notify all WifiPhyListener that the reception has started for the given duration.
 
void NotifySleep ()
 Notify all WifiPhyListener that we are going to sleep.
 
void NotifySwitchingStart (Time duration)
 Notify all WifiPhyListener that we are switching channel with the given channel switching delay.
 
void NotifyTxStart (Time duration, double txPowerDbm)
 Notify all WifiPhyListener that the transmission has started for the given duration.
 
void NotifyWakeup ()
 Notify all WifiPhyListener that we woke up.
 

Private Attributes

Time m_endCcaBusy
 end CCA busy
 
Time m_endRx
 end receive
 
Time m_endSwitching
 end switching
 
Time m_endTx
 end transmit
 
bool m_isOff
 switched off
 
Listeners m_listeners
 listeners
 
Time m_previousStateChangeTime
 previous state change time
 
RxErrorCallback m_rxErrorCallback
 receive error callback
 
TracedCallback< Ptr< const Packet >, doublem_rxErrorTrace
 receive error trace callback
 
RxOkCallback m_rxOkCallback
 receive OK callback
 
TracedCallback< Ptr< const Packet >, double, WifiMode, WifiPreamblem_rxOkTrace
 receive OK trace callback
 
bool m_sleeping
 sleeping
 
Time m_startCcaBusy
 start CCA busy
 
Time m_startRx
 start receive
 
Time m_startSleep
 start sleep
 
Time m_startSwitching
 start switching
 
Time m_startTx
 start transmit
 
TracedCallback< Time, Time, WifiPhyStatem_stateLogger
 The trace source fired when state is changed.
 
TracedCallback< Ptr< const Packet >, WifiMode, WifiPreamble, uint8_t > m_txTrace
 transmit trace callback
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
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.
 

Detailed Description

This objects implements the PHY state machine of the Wifi device.

Config Paths

ns3::WifiPhyStateHelper is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/State"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/State"

No Attributes are defined for this type.

TraceSources

Size of this type is 224 bytes (on a 64-bit architecture).

Definition at line 68 of file wifi-phy-state-helper.h.

Member Typedef Documentation

◆ Listeners

typedef std::vector<WifiPhyListener*> ns3::WifiPhyStateHelper::Listeners
private

typedef for a list of WifiPhyListeners

Definition at line 316 of file wifi-phy-state-helper.h.

◆ RxEndErrorTracedCallback

typedef void(* ns3::WifiPhyStateHelper::RxEndErrorTracedCallback) (Ptr< const Packet > packet, double snr)

TracedCallback signature for receive end error event.

Parameters
[in]packetThe received packet.
[in]snrThe SNR of the received packet in linear scale.

Definition at line 297 of file wifi-phy-state-helper.h.

◆ RxOkTracedCallback

typedef void(* ns3::WifiPhyStateHelper::RxOkTracedCallback) (Ptr< const Packet > packet, double snr, WifiMode mode, WifiPreamble preamble)

TracedCallback signature for receive end OK event.

Parameters
[in]packetThe received packet.
[in]snrThe SNR of the received packet in linear scale.
[in]modeThe transmission mode of the packet.
[in]preambleThe preamble of the packet.

Definition at line 286 of file wifi-phy-state-helper.h.

◆ StateTracedCallback

typedef void(* ns3::WifiPhyStateHelper::StateTracedCallback) (Time start, Time duration, WifiPhyState state)

TracedCallback signature for state changes.

Parameters
[in]startTime when the state started.
[in]durationAmount of time we've been in (or will be in) the state.
[in]stateThe state.

Definition at line 276 of file wifi-phy-state-helper.h.

◆ TxTracedCallback

typedef void(* ns3::WifiPhyStateHelper::TxTracedCallback) (Ptr< const Packet > packet, WifiMode mode, WifiPreamble preamble, uint8_t power)

TracedCallback signature for transmit event.

Parameters
[in]packetThe received packet.
[in]modeThe transmission mode of the packet.
[in]preambleThe preamble of the packet.
[in]powerThe transmit power level.

Definition at line 307 of file wifi-phy-state-helper.h.

Constructor & Destructor Documentation

◆ WifiPhyStateHelper()

ns3::WifiPhyStateHelper::WifiPhyStateHelper ( )

Definition at line 68 of file wifi-phy-state-helper.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoSwitchFromRx()

void ns3::WifiPhyStateHelper::DoSwitchFromRx ( )
private

Switch the state from RX.

Definition at line 537 of file wifi-phy-state-helper.cc.

References IsStateCcaBusy(), IsStateIdle(), m_endRx, m_previousStateChangeTime, m_startRx, m_stateLogger, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by SwitchFromRxAbort(), SwitchFromRxEndError(), and SwitchFromRxEndOk().

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

◆ GetDelayUntilIdle()

Time ns3::WifiPhyStateHelper::GetDelayUntilIdle ( ) const

Return the time before the state is back to IDLE.

Returns
the delay before the state is back to IDLE

Definition at line 156 of file wifi-phy-state-helper.cc.

References GetState(), m_endCcaBusy, m_endRx, m_endSwitching, m_endTx, Max, ns3::Simulator::Now(), NS_FATAL_ERROR, and ns3::Seconds().

+ Here is the call graph for this function:

◆ GetLastRxEndTime()

Time ns3::WifiPhyStateHelper::GetLastRxEndTime ( ) const

Return the time the last RX end.

Returns
the time the last RX end.

Definition at line 195 of file wifi-phy-state-helper.cc.

References m_endRx.

◆ GetLastRxStartTime()

Time ns3::WifiPhyStateHelper::GetLastRxStartTime ( ) const

Return the time the last RX start.

Returns
the time the last RX start.

Definition at line 189 of file wifi-phy-state-helper.cc.

References m_startRx.

◆ GetState()

WifiPhyState ns3::WifiPhyStateHelper::GetState ( ) const

Return the current state of WifiPhy.

Returns
the current state of WifiPhy

Definition at line 201 of file wifi-phy-state-helper.cc.

References m_endCcaBusy, m_endRx, m_endSwitching, m_endTx, m_isOff, m_sleeping, and ns3::Simulator::Now().

Referenced by GetDelayUntilIdle(), IsStateCcaBusy(), IsStateIdle(), IsStateOff(), IsStateRx(), IsStateSleep(), IsStateSwitching(), IsStateTx(), LogPreviousIdleAndCcaBusyStates(), SwitchMaybeToCcaBusy(), SwitchToChannelSwitching(), SwitchToOff(), SwitchToRx(), SwitchToSleep(), and SwitchToTx().

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

◆ GetTypeId()

TypeId ns3::WifiPhyStateHelper::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 42 of file wifi-phy-state-helper.cc.

References m_rxErrorTrace, m_rxOkTrace, m_stateLogger, m_txTrace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsStateCcaBusy()

bool ns3::WifiPhyStateHelper::IsStateCcaBusy ( ) const

Check whether the current state is CCA busy.

Returns
true if the current state is CCA busy, false otherwise

Definition at line 120 of file wifi-phy-state-helper.cc.

References GetState().

Referenced by DoSwitchFromRx(), SwitchFromRxAbort(), and SwitchToRx().

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

◆ IsStateIdle()

bool ns3::WifiPhyStateHelper::IsStateIdle ( ) const

Check whether the current state is IDLE.

Returns
true if the current state is IDLE, false otherwise

Definition at line 114 of file wifi-phy-state-helper.cc.

References GetState().

Referenced by DoSwitchFromRx(), SwitchFromRxAbort(), and SwitchToRx().

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

◆ IsStateOff()

bool ns3::WifiPhyStateHelper::IsStateOff ( ) const

Check whether the current state is OFF.

Returns
true if the current state is OFF, false otherwise

Definition at line 150 of file wifi-phy-state-helper.cc.

References GetState().

Referenced by SwitchFromOff(), and SwitchToOff().

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

◆ IsStateRx()

bool ns3::WifiPhyStateHelper::IsStateRx ( ) const

Check whether the current state is RX.

Returns
true if the current state is RX, false otherwise

Definition at line 126 of file wifi-phy-state-helper.cc.

References GetState().

Referenced by SwitchToRx().

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

◆ IsStateSleep()

bool ns3::WifiPhyStateHelper::IsStateSleep ( ) const

Check whether the current state is SLEEP.

Returns
true if the current state is SLEEP, false otherwise

Definition at line 144 of file wifi-phy-state-helper.cc.

References GetState().

Referenced by SwitchFromSleep(), and SwitchToSleep().

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

◆ IsStateSwitching()

bool ns3::WifiPhyStateHelper::IsStateSwitching ( ) const

Check whether the current state is SWITCHING.

Returns
true if the current state is SWITCHING, false otherwise

Definition at line 138 of file wifi-phy-state-helper.cc.

References GetState().

Referenced by SwitchToChannelSwitching().

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

◆ IsStateTx()

bool ns3::WifiPhyStateHelper::IsStateTx ( ) const

Check whether the current state is TX.

Returns
true if the current state is TX, false otherwise

Definition at line 132 of file wifi-phy-state-helper.cc.

References GetState().

+ Here is the call graph for this function:

◆ LogPreviousIdleAndCcaBusyStates()

void ns3::WifiPhyStateHelper::LogPreviousIdleAndCcaBusyStates ( )
private

Log the idle and CCA busy states.

Definition at line 336 of file wifi-phy-state-helper.cc.

References GetState(), ns3::Time::IsStrictlyPositive(), m_endCcaBusy, m_endRx, m_endSwitching, m_endTx, m_startCcaBusy, m_stateLogger, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by SwitchMaybeToCcaBusy(), SwitchToChannelSwitching(), SwitchToOff(), SwitchToRx(), SwitchToSleep(), and SwitchToTx().

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

◆ NotifyCcaBusyStart()

void ns3::WifiPhyStateHelper::NotifyCcaBusyStart ( Time  duration,
WifiChannelListType  channelType,
const std::vector< Time > &  per20MhzDurations 
)
private

Notify all WifiPhyListener that the CCA has started for the given duration.

Parameters
durationthe duration of the CCA state
channelTypethe channel type for which the CCA busy state is reported.
per20MhzDurationsvector that indicates for how long each 20 MHz subchannel (corresponding to the index of the element in the vector) is busy and where a zero duration indicates that the subchannel is idle. The vector is non-empty if the PHY supports 802.11ax or later and if the operational channel width is larger than 20 MHz.

Definition at line 274 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchFromRxAbort(), and SwitchMaybeToCcaBusy().

+ Here is the caller graph for this function:

◆ NotifyOff()

void ns3::WifiPhyStateHelper::NotifyOff ( )
private

Notify all WifiPhyListener that we are going to switch off.

Definition at line 306 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchToOff().

+ Here is the caller graph for this function:

◆ NotifyOn()

void ns3::WifiPhyStateHelper::NotifyOn ( )
private

Notify all WifiPhyListener that we are going to switch on.

Definition at line 326 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchFromOff().

+ Here is the caller graph for this function:

◆ NotifyRxEndError()

void ns3::WifiPhyStateHelper::NotifyRxEndError ( )
private

Notify all WifiPhyListener that the reception was not successful.

Definition at line 264 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchFromRxEndError().

+ Here is the caller graph for this function:

◆ NotifyRxEndOk()

void ns3::WifiPhyStateHelper::NotifyRxEndOk ( )
private

Notify all WifiPhyListener that the reception was successful.

Definition at line 254 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchFromRxAbort(), and SwitchFromRxEndOk().

+ Here is the caller graph for this function:

◆ NotifyRxMpdu()

void ns3::WifiPhyStateHelper::NotifyRxMpdu ( Ptr< const WifiPsdu psdu,
RxSignalInfo  rxSignalInfo,
const WifiTxVector txVector 
)

Notify the reception of an MPDU included in an A-MPDU.

Parameters
psduthe successfully received PSDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorTXVECTOR of the PSDU

Definition at line 468 of file wifi-phy-state-helper.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_rxOkCallback, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ NotifyRxPsduFailed()

void ns3::WifiPhyStateHelper::NotifyRxPsduFailed ( Ptr< const WifiPsdu psdu,
double  snr 
)

Handle the unsuccessful reception of a PSDU.

Parameters
psduthe PSDU that we failed to received
snrthe SNR of the received PSDU in linear scale

Definition at line 505 of file wifi-phy-state-helper.cc.

References ns3::Callback< R, UArgs >::IsNull(), m_rxErrorCallback, m_rxErrorTrace, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ NotifyRxPsduSucceeded()

void ns3::WifiPhyStateHelper::NotifyRxPsduSucceeded ( Ptr< const WifiPsdu psdu,
RxSignalInfo  rxSignalInfo,
const WifiTxVector txVector,
uint16_t  staId,
const std::vector< bool > &  statusPerMpdu 
)

Handle the successful reception of a PSDU.

Parameters
psduthe successfully received PSDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorTXVECTOR of the PSDU
staIdthe station ID of the PSDU (only used for MU)
statusPerMpdureception status per MPDU

Definition at line 480 of file wifi-phy-state-helper.cc.

References ns3::WifiTxVector::GetMode(), ns3::WifiTxVector::GetPreambleType(), ns3::Callback< R, UArgs >::IsNull(), m_rxOkCallback, m_rxOkTrace, NS_ASSERT, NS_LOG_FUNCTION, and ns3::RxSignalInfo::snr.

+ Here is the call graph for this function:

◆ NotifyRxStart()

void ns3::WifiPhyStateHelper::NotifyRxStart ( Time  duration)
private

Notify all WifiPhyListener that the reception has started for the given duration.

Parameters
durationthe duration of the reception

Definition at line 244 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchToRx().

+ Here is the caller graph for this function:

◆ NotifySleep()

void ns3::WifiPhyStateHelper::NotifySleep ( )
private

Notify all WifiPhyListener that we are going to sleep.

Definition at line 296 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchToSleep().

+ Here is the caller graph for this function:

◆ NotifySwitchingStart()

void ns3::WifiPhyStateHelper::NotifySwitchingStart ( Time  duration)
private

Notify all WifiPhyListener that we are switching channel with the given channel switching delay.

Parameters
durationthe delay to switch the channel

Definition at line 286 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchToChannelSwitching().

+ Here is the caller graph for this function:

◆ NotifyTxStart()

void ns3::WifiPhyStateHelper::NotifyTxStart ( Time  duration,
double  txPowerDbm 
)
private

Notify all WifiPhyListener that the transmission has started for the given duration.

Parameters
durationthe duration of the transmission
txPowerDbmthe nominal TX power in dBm

Definition at line 234 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchToTx().

+ Here is the caller graph for this function:

◆ NotifyWakeup()

void ns3::WifiPhyStateHelper::NotifyWakeup ( )
private

Notify all WifiPhyListener that we woke up.

Definition at line 316 of file wifi-phy-state-helper.cc.

References m_listeners, and NS_LOG_FUNCTION.

Referenced by SwitchFromSleep().

+ Here is the caller graph for this function:

◆ RegisterListener()

void ns3::WifiPhyStateHelper::RegisterListener ( WifiPhyListener listener)

Register WifiPhyListener to this WifiPhyStateHelper.

Parameters
listenerthe WifiPhyListener to register

Definition at line 98 of file wifi-phy-state-helper.cc.

References m_listeners.

◆ SetReceiveErrorCallback()

void ns3::WifiPhyStateHelper::SetReceiveErrorCallback ( RxErrorCallback  callback)

Set a callback for a failed reception.

Parameters
callbackthe RxErrorCallback to set

Definition at line 92 of file wifi-phy-state-helper.cc.

References m_rxErrorCallback.

◆ SetReceiveOkCallback()

void ns3::WifiPhyStateHelper::SetReceiveOkCallback ( RxOkCallback  callback)

Set a callback for a successful reception.

Parameters
callbackthe RxOkCallback to set

Definition at line 86 of file wifi-phy-state-helper.cc.

References m_rxOkCallback.

◆ SwitchFromOff()

void ns3::WifiPhyStateHelper::SwitchFromOff ( )

Switch from off mode.

Definition at line 665 of file wifi-phy-state-helper.cc.

References IsStateOff(), m_isOff, m_previousStateChangeTime, NotifyOn(), ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SwitchFromRxAbort()

void ns3::WifiPhyStateHelper::SwitchFromRxAbort ( uint16_t  operatingWidth)

Abort current reception following a CCA reset request.

Parameters
operatingWidththe channel width the PHY is operating on (in MHz)

Definition at line 611 of file wifi-phy-state-helper.cc.

References DoSwitchFromRx(), IsStateCcaBusy(), IsStateIdle(), m_endCcaBusy, NotifyCcaBusyStart(), NotifyRxEndOk(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Seconds(), and ns3::WIFI_CHANLIST_PRIMARY.

+ Here is the call graph for this function:

◆ SwitchFromRxEndError()

void ns3::WifiPhyStateHelper::SwitchFromRxEndError ( )

Switch from RX after the reception failed.

Definition at line 528 of file wifi-phy-state-helper.cc.

References DoSwitchFromRx(), m_endRx, NotifyRxEndError(), ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SwitchFromRxEndOk()

void ns3::WifiPhyStateHelper::SwitchFromRxEndOk ( )

Switch from RX after the reception was successful.

Definition at line 519 of file wifi-phy-state-helper.cc.

References DoSwitchFromRx(), m_endRx, NotifyRxEndOk(), ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SwitchFromSleep()

void ns3::WifiPhyStateHelper::SwitchFromSleep ( )

Switch from sleep mode.

Definition at line 599 of file wifi-phy-state-helper.cc.

References IsStateSleep(), m_previousStateChangeTime, m_sleeping, m_startSleep, m_stateLogger, NotifyWakeup(), ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SwitchMaybeToCcaBusy()

void ns3::WifiPhyStateHelper::SwitchMaybeToCcaBusy ( Time  duration,
WifiChannelListType  channelType,
const std::vector< Time > &  per20MhzDurations 
)

Switch to CCA busy.

Parameters
durationthe duration of the CCA state
channelTypethe channel type for which the CCA busy state is reported.
per20MhzDurationsvector that indicates for how long each 20 MHz subchannel (corresponding to the index of the element in the vector) is busy and where a zero duration indicates that the subchannel is idle. The vector is non-empty if the PHY supports 802.11ax or later and if the operational channel width is larger than 20 MHz.

Definition at line 548 of file wifi-phy-state-helper.cc.

References GetState(), LogPreviousIdleAndCcaBusyStates(), m_endCcaBusy, m_startCcaBusy, NotifyCcaBusyStart(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::WIFI_CHANLIST_PRIMARY.

+ Here is the call graph for this function:

◆ SwitchToChannelSwitching()

void ns3::WifiPhyStateHelper::SwitchToChannelSwitching ( Time  switchingDuration)

Switch state to channel switching for the given duration.

Parameters
switchingDurationthe duration of required to switch the channel

Definition at line 435 of file wifi-phy-state-helper.cc.

References GetState(), IsStateSwitching(), ns3::Time::IsZero(), LogPreviousIdleAndCcaBusyStates(), m_endCcaBusy, m_endRx, m_endSwitching, m_previousStateChangeTime, m_startRx, m_startSwitching, m_stateLogger, NotifySwitchingStart(), ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SwitchToOff()

void ns3::WifiPhyStateHelper::SwitchToOff ( )

◆ SwitchToRx()

void ns3::WifiPhyStateHelper::SwitchToRx ( Time  rxDuration)

Switch state to RX for the given duration.

Parameters
rxDurationthe duration of the RX

Definition at line 411 of file wifi-phy-state-helper.cc.

References GetState(), IsStateCcaBusy(), IsStateIdle(), IsStateRx(), LogPreviousIdleAndCcaBusyStates(), m_endRx, m_previousStateChangeTime, m_startRx, NotifyRxStart(), ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SwitchToSleep()

void ns3::WifiPhyStateHelper::SwitchToSleep ( )

◆ SwitchToTx()

void ns3::WifiPhyStateHelper::SwitchToTx ( Time  txDuration,
WifiConstPsduMap  psdus,
double  txPowerDbm,
const WifiTxVector txVector 
)

Switch state to TX for the given duration.

Parameters
txDurationthe duration of the PPDU to transmit
psdusthe PSDUs in the transmitted PPDU (only one unless it is a MU PPDU)
txPowerDbmthe nominal TX power in dBm
txVectorthe TX vector for the transmission

Definition at line 368 of file wifi-phy-state-helper.cc.

References ns3::WifiTxVector::GetMode(), ns3::WifiTxVector::GetPreambleType(), GetState(), ns3::WifiTxVector::GetTxPowerLevel(), LogPreviousIdleAndCcaBusyStates(), m_endRx, m_endTx, m_previousStateChangeTime, m_startRx, m_startTx, m_stateLogger, m_txTrace, NotifyTxStart(), ns3::Simulator::Now(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ UnregisterListener()

void ns3::WifiPhyStateHelper::UnregisterListener ( WifiPhyListener listener)

Remove WifiPhyListener from this WifiPhyStateHelper.

Parameters
listenerthe WifiPhyListener to unregister

Definition at line 104 of file wifi-phy-state-helper.cc.

References m_listeners.

Member Data Documentation

◆ m_endCcaBusy

Time ns3::WifiPhyStateHelper::m_endCcaBusy
private

◆ m_endRx

◆ m_endSwitching

Time ns3::WifiPhyStateHelper::m_endSwitching
private

◆ m_endTx

Time ns3::WifiPhyStateHelper::m_endTx
private

◆ m_isOff

bool ns3::WifiPhyStateHelper::m_isOff
private

switched off

Definition at line 391 of file wifi-phy-state-helper.h.

Referenced by GetState(), SwitchFromOff(), and SwitchToOff().

◆ m_listeners

◆ m_previousStateChangeTime

Time ns3::WifiPhyStateHelper::m_previousStateChangeTime
private

◆ m_rxErrorCallback

RxErrorCallback ns3::WifiPhyStateHelper::m_rxErrorCallback
private

receive error callback

Definition at line 410 of file wifi-phy-state-helper.h.

Referenced by NotifyRxPsduFailed(), and SetReceiveErrorCallback().

◆ m_rxErrorTrace

TracedCallback<Ptr<const Packet>, double> ns3::WifiPhyStateHelper::m_rxErrorTrace
private

receive error trace callback

Definition at line 406 of file wifi-phy-state-helper.h.

Referenced by GetTypeId(), and NotifyRxPsduFailed().

◆ m_rxOkCallback

RxOkCallback ns3::WifiPhyStateHelper::m_rxOkCallback
private

receive OK callback

Definition at line 409 of file wifi-phy-state-helper.h.

Referenced by NotifyRxMpdu(), NotifyRxPsduSucceeded(), and SetReceiveOkCallback().

◆ m_rxOkTrace

TracedCallback<Ptr<const Packet>, double, WifiMode, WifiPreamble> ns3::WifiPhyStateHelper::m_rxOkTrace
private

receive OK trace callback

Definition at line 405 of file wifi-phy-state-helper.h.

Referenced by GetTypeId(), and NotifyRxPsduSucceeded().

◆ m_sleeping

bool ns3::WifiPhyStateHelper::m_sleeping
private

sleeping

Definition at line 390 of file wifi-phy-state-helper.h.

Referenced by GetState(), SwitchFromSleep(), and SwitchToSleep().

◆ m_startCcaBusy

Time ns3::WifiPhyStateHelper::m_startCcaBusy
private

start CCA busy

Definition at line 398 of file wifi-phy-state-helper.h.

Referenced by LogPreviousIdleAndCcaBusyStates(), and SwitchMaybeToCcaBusy().

◆ m_startRx

Time ns3::WifiPhyStateHelper::m_startRx
private

◆ m_startSleep

Time ns3::WifiPhyStateHelper::m_startSleep
private

start sleep

Definition at line 400 of file wifi-phy-state-helper.h.

Referenced by SwitchFromSleep(), and SwitchToSleep().

◆ m_startSwitching

Time ns3::WifiPhyStateHelper::m_startSwitching
private

start switching

Definition at line 399 of file wifi-phy-state-helper.h.

Referenced by SwitchToChannelSwitching().

◆ m_startTx

Time ns3::WifiPhyStateHelper::m_startTx
private

start transmit

Definition at line 396 of file wifi-phy-state-helper.h.

Referenced by SwitchToOff(), and SwitchToTx().

◆ m_stateLogger

TracedCallback<Time, Time, WifiPhyState> ns3::WifiPhyStateHelper::m_stateLogger
private

The trace source fired when state is changed.

Definition at line 388 of file wifi-phy-state-helper.h.

Referenced by DoSwitchFromRx(), GetTypeId(), LogPreviousIdleAndCcaBusyStates(), SwitchFromSleep(), SwitchToChannelSwitching(), SwitchToOff(), and SwitchToTx().

◆ m_txTrace

TracedCallback<Ptr<const Packet>, WifiMode, WifiPreamble, uint8_t> ns3::WifiPhyStateHelper::m_txTrace
private

transmit trace callback

Definition at line 408 of file wifi-phy-state-helper.h.

Referenced by GetTypeId(), and SwitchToTx().


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