A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 Member Functions

 WifiPhyStateHelper ()
 
Time GetDelayUntilIdle (void)
 Return the time before the state is back to IDLE. More...
 
Time GetLastRxStartTime (void) const
 Return the time the last RX start. More...
 
enum WifiPhy::State GetState (void)
 Return the current state of WifiPhy. More...
 
Time GetStateDuration (void)
 Return the elapsed time of the current state. More...
 
bool IsStateBusy (void)
 Check whether the current state is not IDLE. More...
 
bool IsStateCcaBusy (void)
 Check whether the current state is CCA busy. More...
 
bool IsStateIdle (void)
 Check whether the current state is IDLE. More...
 
bool IsStateRx (void)
 Check whether the current state is RX. More...
 
bool IsStateSwitching (void)
 Check whether the current state is SWITCHING. More...
 
bool IsStateTx (void)
 Check whether the current state is TX. More...
 
void RegisterListener (WifiPhyListener *listener)
 Register WifiPhyListener to this WifiPhyStateHelper. More...
 
void SetReceiveErrorCallback (WifiPhy::RxErrorCallback callback)
 Set a callback for a failed reception. More...
 
void SetReceiveOkCallback (WifiPhy::RxOkCallback callback)
 Set a callback for a successful reception. More...
 
void SwitchFromRxEndError (Ptr< const Packet > packet, double snr)
 Switch from RX after the reception failed. More...
 
void SwitchFromRxEndOk (Ptr< Packet > packet, double snr, WifiMode mode, enum WifiPreamble preamble)
 Switch from RX after the reception was successful. More...
 
void SwitchMaybeToCcaBusy (Time duration)
 Switch to CCA busy. More...
 
void SwitchToChannelSwitching (Time switchingDuration)
 Switch state to channel switching for the given duration. More...
 
void SwitchToRx (Time rxDuration)
 Switch state to RX for the given duration. More...
 
void SwitchToTx (Time txDuration, Ptr< const Packet > packet, WifiMode txMode, WifiPreamble preamble, uint8_t txPower)
 Switch state to TX for the given duration. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
AggregateIterator GetAggregateIterator (void) const
 
virtual TypeId GetInstanceTypeId (void) const
 
template<typename T >
Ptr< T > GetObject (void) const
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 
void Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Public Attributes

TracedCallback< Time, Time,
enum WifiPhy::State
m_stateLogger
 

Private Types

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

Private Member Functions

void DoSwitchFromRx (void)
 Switch the state from RX. More...
 
void LogPreviousIdleAndCcaBusyStates (void)
 Log the ideal and CCA states. More...
 
void NotifyMaybeCcaBusyStart (Time duration)
 Notify all WifiPhyListener that the CCA has started for the given duration. More...
 
void NotifyRxEndError (void)
 Notify all WifiPhyListener that the reception was not successful. More...
 
void NotifyRxEndOk (void)
 Notify all WifiPhyListener that the reception was successful. More...
 
void NotifyRxStart (Time duration)
 Notify all WifiPhyListener that the reception has started for the given duration. More...
 
void NotifySwitchingStart (Time duration)
 Notify all WifiPhyListener that we are switching channel with the given channel switching delay. More...
 
void NotifyTxStart (Time duration)
 Notify all WifiPhyListener that the transmission has started for the given duration. More...
 

Private Attributes

Time m_endCcaBusy
 
Time m_endRx
 
Time m_endSwitching
 
Time m_endTx
 
Listeners m_listeners
 
Time m_previousStateChangeTime
 
WifiPhy::RxErrorCallback m_rxErrorCallback
 
TracedCallback< Ptr< const
Packet >, double > 
m_rxErrorTrace
 
bool m_rxing
 
WifiPhy::RxOkCallback m_rxOkCallback
 
TracedCallback< Ptr< const
Packet >, double, WifiMode,
enum WifiPreamble
m_rxOkTrace
 
Time m_startCcaBusy
 
Time m_startRx
 
Time m_startSwitching
 
Time m_startTx
 
TracedCallback< Ptr< const
Packet >, WifiMode,
WifiPreamble, uint8_t > 
m_txTrace
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

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/$ns3::YansWifiPhy/State

No Attributes are defined for this type.

TraceSources

  • State: The state of the PHY layer
  • RxOk: A packet has been received successfully.
  • RxError: A packet has been received unsuccessfully.
  • Tx: Packet transmission is starting.

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

Member Typedef Documentation

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

typedef for a list of WifiPhyListeners

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

Constructor & Destructor Documentation

ns3::WifiPhyStateHelper::WifiPhyStateHelper ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::WifiPhyStateHelper::DoSwitchFromRx ( void  )
private

Switch the state from RX.

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

References IsStateCcaBusy(), IsStateIdle(), IsStateRx(), m_previousStateChangeTime, m_rxing, m_startRx, m_stateLogger, ns3::Simulator::Now(), NS_ASSERT, and ns3::WifiPhy::RX.

Referenced by SwitchFromRxEndError(), and SwitchFromRxEndOk().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Time ns3::WifiPhyStateHelper::GetDelayUntilIdle ( void  )

Return the time before the state is back to IDLE.

Returns
the delay before the state is back to IDLE

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

References ns3::WifiPhy::CCA_BUSY, GetState(), ns3::WifiPhy::IDLE, m_endCcaBusy, m_endRx, m_endSwitching, m_endTx, ns3::Max(), ns3::Simulator::Now(), NS_FATAL_ERROR, ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

+ Here is the call graph for this function:

Time ns3::WifiPhyStateHelper::GetLastRxStartTime ( void  ) const

Return the time the last RX start.

Returns
the time the last RX start.

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

References m_startRx.

enum WifiPhy::State ns3::WifiPhyStateHelper::GetState ( void  )

Return the current state of WifiPhy.

Returns
the current state of WifiPhy

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

References ns3::WifiPhy::CCA_BUSY, ns3::WifiPhy::IDLE, m_endCcaBusy, m_endSwitching, m_endTx, m_rxing, ns3::Simulator::Now(), ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

Referenced by GetDelayUntilIdle(), IsStateBusy(), IsStateCcaBusy(), IsStateIdle(), IsStateRx(), IsStateSwitching(), IsStateTx(), SwitchMaybeToCcaBusy(), SwitchToChannelSwitching(), SwitchToRx(), and SwitchToTx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Time ns3::WifiPhyStateHelper::GetStateDuration ( void  )

Return the elapsed time of the current state.

Returns
the elapsed time of the current state

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

References m_previousStateChangeTime, and ns3::Simulator::Now().

+ Here is the call graph for this function:

TypeId ns3::WifiPhyStateHelper::GetTypeId ( void  )
static

Definition at line 33 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:

bool ns3::WifiPhyStateHelper::IsStateBusy ( void  )

Check whether the current state is not IDLE.

Returns
true if the current state is not IDLE, false otherwise

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

References GetState(), and ns3::WifiPhy::IDLE.

+ Here is the call graph for this function:

bool ns3::WifiPhyStateHelper::IsStateCcaBusy ( void  )

Check whether the current state is CCA busy.

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

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

References ns3::WifiPhy::CCA_BUSY, and GetState().

Referenced by DoSwitchFromRx(), and SwitchToRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::WifiPhyStateHelper::IsStateIdle ( void  )

Check whether the current state is IDLE.

Returns
true if the current state is IDLE, false otherwise

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

References GetState(), and ns3::WifiPhy::IDLE.

Referenced by DoSwitchFromRx(), and SwitchToRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::WifiPhyStateHelper::IsStateRx ( void  )

Check whether the current state is RX.

Returns
true if the current state is RX, false otherwise

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

References GetState(), and ns3::WifiPhy::RX.

Referenced by DoSwitchFromRx(), and SwitchToRx().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::WifiPhyStateHelper::IsStateSwitching ( void  )

Check whether the current state is SWITCHING.

Returns
true if the current state is SWITCHING, false otherwise

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

References GetState(), and ns3::WifiPhy::SWITCHING.

Referenced by SwitchToChannelSwitching().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::WifiPhyStateHelper::IsStateTx ( void  )

Check whether the current state is TX.

Returns
true if the current state is TX, false otherwise

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

References GetState(), and ns3::WifiPhy::TX.

+ Here is the call graph for this function:

void ns3::WifiPhyStateHelper::LogPreviousIdleAndCcaBusyStates ( void  )
private

Log the ideal and CCA states.

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

References ns3::WifiPhy::CCA_BUSY, ns3::WifiPhy::IDLE, m_endCcaBusy, m_endRx, m_endSwitching, m_endTx, m_startCcaBusy, m_stateLogger, ns3::Max(), ns3::Simulator::Now(), and NS_ASSERT.

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

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

Parameters
durationthe duration of the CCA state

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

References m_listeners.

Referenced by SwitchMaybeToCcaBusy().

+ Here is the caller graph for this function:

void ns3::WifiPhyStateHelper::NotifyRxEndError ( void  )
private

Notify all WifiPhyListener that the reception was not successful.

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

References m_listeners.

Referenced by SwitchFromRxEndError().

+ Here is the caller graph for this function:

void ns3::WifiPhyStateHelper::NotifyRxEndOk ( void  )
private

Notify all WifiPhyListener that the reception was successful.

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

References m_listeners.

Referenced by SwitchFromRxEndOk().

+ Here is the caller graph for this function:

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 195 of file wifi-phy-state-helper.cc.

References m_listeners.

Referenced by SwitchToRx().

+ Here is the caller graph for this function:

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 227 of file wifi-phy-state-helper.cc.

References m_listeners.

Referenced by SwitchToChannelSwitching().

+ Here is the caller graph for this function:

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

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

Parameters
durationthe duration of the transmission

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

References m_listeners.

Referenced by SwitchToTx().

+ Here is the caller graph for this function:

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

Register WifiPhyListener to this WifiPhyStateHelper.

Parameters
listener

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

References m_listeners.

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

Set a callback for a failed reception.

Parameters
callback

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

References m_rxErrorCallback.

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

Set a callback for a successful reception.

Parameters
callback

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

References m_rxOkCallback.

void ns3::WifiPhyStateHelper::SwitchFromRxEndError ( Ptr< const Packet packet,
double  snr 
)

Switch from RX after the reception failed.

Parameters
packetthe packet that we failed to received
snrthe SNR of the received packet

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

References DoSwitchFromRx(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_rxErrorCallback, m_rxErrorTrace, and NotifyRxEndError().

+ Here is the call graph for this function:

void ns3::WifiPhyStateHelper::SwitchFromRxEndOk ( Ptr< Packet packet,
double  snr,
WifiMode  mode,
enum WifiPreamble  preamble 
)

Switch from RX after the reception was successful.

Parameters
packetthe successfully received packet
snrthe SNR of the received packet
modethe transmission mode of the packet
preamblethe preamble of the received packet

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

References DoSwitchFromRx(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_rxOkCallback, m_rxOkTrace, and NotifyRxEndOk().

+ Here is the call graph for this function:

void ns3::WifiPhyStateHelper::SwitchMaybeToCcaBusy ( Time  duration)

Switch to CCA busy.

Parameters
durationthe duration of CCA busy state

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

References ns3::WifiPhy::CCA_BUSY, GetState(), ns3::WifiPhy::IDLE, LogPreviousIdleAndCcaBusyStates(), m_endCcaBusy, m_startCcaBusy, NotifyMaybeCcaBusyStart(), ns3::Simulator::Now(), ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

+ Here is the call graph for this function:

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 325 of file wifi-phy-state-helper.cc.

References ns3::WifiPhy::CCA_BUSY, GetState(), ns3::WifiPhy::IDLE, IsStateSwitching(), LogPreviousIdleAndCcaBusyStates(), m_endCcaBusy, m_endRx, m_endSwitching, m_endTx, m_previousStateChangeTime, m_rxing, m_startCcaBusy, m_startRx, m_startSwitching, m_stateLogger, ns3::Max(), NotifySwitchingStart(), ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

+ Here is the call graph for this function:

void ns3::WifiPhyStateHelper::SwitchToRx ( Time  rxDuration)
void ns3::WifiPhyStateHelper::SwitchToTx ( Time  txDuration,
Ptr< const Packet packet,
WifiMode  txMode,
WifiPreamble  preamble,
uint8_t  txPower 
)

Switch state to TX for the given duration.

Parameters
txDurationthe duration of the TX
packetthe packet
txModethe transmission mode of the packet
preamblethe preamble of the packet
txPowerthe transmission power

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

References ns3::WifiPhy::CCA_BUSY, GetState(), ns3::WifiPhy::IDLE, LogPreviousIdleAndCcaBusyStates(), m_endRx, m_endSwitching, m_endTx, m_previousStateChangeTime, m_rxing, m_startCcaBusy, m_startRx, m_startTx, m_stateLogger, m_txTrace, ns3::Max(), NotifyTxStart(), ns3::Simulator::Now(), NS_FATAL_ERROR, ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

+ Here is the call graph for this function:

Member Data Documentation

Time ns3::WifiPhyStateHelper::m_endCcaBusy
private
Time ns3::WifiPhyStateHelper::m_endRx
private
Time ns3::WifiPhyStateHelper::m_endSwitching
private
Time ns3::WifiPhyStateHelper::m_endTx
private
Listeners ns3::WifiPhyStateHelper::m_listeners
private
Time ns3::WifiPhyStateHelper::m_previousStateChangeTime
private
WifiPhy::RxErrorCallback ns3::WifiPhyStateHelper::m_rxErrorCallback
private

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

Referenced by SetReceiveErrorCallback(), and SwitchFromRxEndError().

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

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

Referenced by GetTypeId(), and SwitchFromRxEndError().

bool ns3::WifiPhyStateHelper::m_rxing
private
WifiPhy::RxOkCallback ns3::WifiPhyStateHelper::m_rxOkCallback
private

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

Referenced by SetReceiveOkCallback(), and SwitchFromRxEndOk().

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

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

Referenced by GetTypeId(), and SwitchFromRxEndOk().

Time ns3::WifiPhyStateHelper::m_startCcaBusy
private
Time ns3::WifiPhyStateHelper::m_startRx
private
Time ns3::WifiPhyStateHelper::m_startSwitching
private

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

Referenced by SwitchToChannelSwitching().

Time ns3::WifiPhyStateHelper::m_startTx
private

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

Referenced by SwitchToTx().

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

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

Referenced by GetTypeId(), and SwitchToTx().


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