A Discrete-Event Network Simulator
API
ns3::WifiRadioEnergyModel Class Reference

A WiFi radio energy model. More...

#include "wifi-radio-energy-model.h"

+ Inheritance diagram for ns3::WifiRadioEnergyModel:
+ Collaboration diagram for ns3::WifiRadioEnergyModel:

Public Types

typedef Callback< void > WifiRadioEnergyDepletionCallback
 Callback type for energy depletion handling. More...
 
typedef Callback< void > WifiRadioEnergyRechargedCallback
 Callback type for energy recharged handling. More...
 
- Public Types inherited from ns3::DeviceEnergyModel
typedef Callback< void, int > ChangeStateCallback
 Callback type for ChangeState function. More...
 

Public Member Functions

 WifiRadioEnergyModel ()
 
virtual ~WifiRadioEnergyModel ()
 
void ChangeState (int newState)
 Changes state of the WifiRadioEnergyMode. More...
 
double GetCcaBusyCurrentA (void) const
 Gets CCA busy current. More...
 
WifiPhyState GetCurrentState (void) const
 
double GetIdleCurrentA (void) const
 Gets idle current. More...
 
Time GetMaximumTimeInState (int state) const
 
WifiRadioEnergyModelPhyListenerGetPhyListener (void)
 
double GetRxCurrentA (void) const
 Gets receive current. More...
 
double GetSleepCurrentA (void) const
 Gets sleep current. More...
 
double GetSwitchingCurrentA (void) const
 Gets switching current. More...
 
double GetTotalEnergyConsumption (void) const
 
double GetTxCurrentA (void) const
 Gets transmit current. More...
 
void HandleEnergyChanged (void)
 Handles energy changed. More...
 
void HandleEnergyDepletion (void)
 Handles energy depletion. More...
 
void HandleEnergyRecharged (void)
 Handles energy recharged. More...
 
void SetCcaBusyCurrentA (double ccaBusyCurrentA)
 Sets CCA busy current. More...
 
void SetEnergyDepletionCallback (WifiRadioEnergyDepletionCallback callback)
 
void SetEnergyRechargedCallback (WifiRadioEnergyRechargedCallback callback)
 
void SetEnergySource (const Ptr< EnergySource > source)
 Sets pointer to EnergySouce installed on node. More...
 
void SetIdleCurrentA (double idleCurrentA)
 Sets idle current. More...
 
void SetRxCurrentA (double rxCurrentA)
 Sets receive current. More...
 
void SetSleepCurrentA (double sleepCurrentA)
 Sets sleep current. More...
 
void SetSwitchingCurrentA (double switchingCurrentA)
 Sets switching current. More...
 
void SetTxCurrentA (double txCurrentA)
 Sets transmit current. More...
 
void SetTxCurrentFromModel (double txPowerDbm)
 Calls the CalcTxCurrent method of the tx current model to compute the tx current based on such model. More...
 
void SetTxCurrentModel (const Ptr< WifiTxCurrentModel > model)
 
- Public Member Functions inherited from ns3::DeviceEnergyModel
 DeviceEnergyModel ()
 
virtual ~DeviceEnergyModel ()
 
double GetCurrentA (void) const
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default 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 operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::DeviceEnergyModel
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::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

void DoDispose (void)
 Destructor implementation. More...
 
double DoGetCurrentA (void) const
 
double GetStateA (int state) const
 
void SetWifiRadioState (const WifiPhyState state)
 

Private Attributes

double m_ccaBusyCurrentA
 CCA busy current. More...
 
WifiPhyState m_currentState
 current state the radio is in More...
 
WifiRadioEnergyDepletionCallback m_energyDepletionCallback
 Energy depletion callback. More...
 
WifiRadioEnergyRechargedCallback m_energyRechargedCallback
 Energy recharged callback. More...
 
double m_idleCurrentA
 idle current More...
 
Time m_lastUpdateTime
 time stamp of previous energy update More...
 
WifiRadioEnergyModelPhyListenerm_listener
 WifiPhy listener. More...
 
uint8_t m_nPendingChangeState
 pending state change More...
 
double m_rxCurrentA
 receive current More...
 
double m_sleepCurrentA
 sleep current More...
 
Ptr< EnergySourcem_source
 energy source More...
 
double m_switchingCurrentA
 switching current More...
 
EventId m_switchToOffEvent
 switch to off event More...
 
TracedValue< double > m_totalEnergyConsumption
 This variable keeps track of the total energy consumed by this model. More...
 
double m_txCurrentA
 transmit current More...
 
Ptr< WifiTxCurrentModelm_txCurrentModel
 current model More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

A WiFi radio energy model.


Introspection did not find any typical Config paths.

4 states are defined for the radio: TX, RX, IDLE, SLEEP. Default state is IDLE. The different types of transactions that are defined are:

  1. Tx: State goes from IDLE to TX, radio is in TX state for TX_duration, then state goes from TX to IDLE.
  2. Rx: State goes from IDLE to RX, radio is in RX state for RX_duration, then state goes from RX to IDLE.
  3. Go_to_Sleep: State goes from IDLE to SLEEP.
  4. End_of_Sleep: State goes from SLEEP to IDLE. The class keeps track of what state the radio is currently in.

Energy calculation: For each transaction, this model notifies EnergySource object. The EnergySource object will query this model for the total current. Then the EnergySource object uses the total current to calculate energy.

Default values for power consumption are based on measurements reported in:

Daniel Halperin, Ben Greenstein, Anmol Sheth, David Wetherall, "Demystifying 802.11n power consumption", Proceedings of HotPower'10

Power consumption in Watts (single antenna):

$ P_{tx} = 1.14 $ (transmit at 0dBm)

$ P_{rx} = 0.94 $

$ P_{idle} = 0.82 $

$ P_{sleep} = 0.10 $

Hence, considering the default supply voltage of 3.0 V for the basic energy source, the default current values in Ampere are:

$ I_{tx} = 0.380 $

$ I_{rx} = 0.313 $

$ I_{idle} = 0.273 $

$ I_{sleep} = 0.033 $

The dependence of the power consumption in transmission mode on the nominal transmit power can also be achieved through a wifi tx current model.


Attributes

  • IdleCurrentA: The default radio Idle current in Ampere.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.273
    • Flags: construct write read
  • CcaBusyCurrentA: The default radio CCA Busy State current in Ampere.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.273
    • Flags: construct write read
  • TxCurrentA: The radio Tx current in Ampere.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.38
    • Flags: construct write read
  • RxCurrentA: The radio Rx current in Ampere.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.313
    • Flags: construct write read
  • SwitchingCurrentA: The default radio Channel Switch current in Ampere.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.273
    • Flags: construct write read
  • SleepCurrentA: The radio Sleep current in Ampere.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0.033
    • Flags: construct write read
  • TxCurrentModel: A pointer to the attached tx current model.

TraceSources

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

Definition at line 213 of file wifi-radio-energy-model.h.

Member Typedef Documentation

◆ WifiRadioEnergyDepletionCallback

Callback type for energy depletion handling.

Definition at line 219 of file wifi-radio-energy-model.h.

◆ WifiRadioEnergyRechargedCallback

Callback type for energy recharged handling.

Definition at line 224 of file wifi-radio-energy-model.h.

Constructor & Destructor Documentation

◆ WifiRadioEnergyModel()

◆ ~WifiRadioEnergyModel()

ns3::WifiRadioEnergyModel::~WifiRadioEnergyModel ( )
virtual

Definition at line 104 of file wifi-radio-energy-model.cc.

References m_listener, m_txCurrentModel, and NS_LOG_FUNCTION.

Member Function Documentation

◆ ChangeState()

void ns3::WifiRadioEnergyModel::ChangeState ( int  newState)
virtual

◆ DoDispose()

void ns3::WifiRadioEnergyModel::DoDispose ( void  )
privatevirtual

Destructor implementation.

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

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

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

Reimplemented from ns3::Object.

Definition at line 390 of file wifi-radio-energy-model.cc.

References m_energyDepletionCallback, m_source, NS_LOG_FUNCTION, and ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::Nullify().

+ Here is the call graph for this function:

◆ DoGetCurrentA()

double ns3::WifiRadioEnergyModel::DoGetCurrentA ( void  ) const
privatevirtual
Returns
Current draw of device, at current state.

Implements DeviceEnergyModel::GetCurrentA.

Reimplemented from ns3::DeviceEnergyModel.

Definition at line 421 of file wifi-radio-energy-model.cc.

References GetStateA(), and m_currentState.

+ Here is the call graph for this function:

◆ GetCcaBusyCurrentA()

double ns3::WifiRadioEnergyModel::GetCcaBusyCurrentA ( void  ) const

Gets CCA busy current.

Returns
CCA Busy current of the wifi device.

Definition at line 155 of file wifi-radio-energy-model.cc.

References m_ccaBusyCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetCurrentState()

WifiPhyState ns3::WifiRadioEnergyModel::GetCurrentState ( void  ) const
Returns
Current state.

Definition at line 225 of file wifi-radio-energy-model.cc.

References m_currentState, and NS_LOG_FUNCTION.

Referenced by BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetIdleCurrentA()

double ns3::WifiRadioEnergyModel::GetIdleCurrentA ( void  ) const

Gets idle current.

Returns
idle current of the wifi device.

Definition at line 141 of file wifi-radio-energy-model.cc.

References m_idleCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetMaximumTimeInState()

Time ns3::WifiRadioEnergyModel::GetMaximumTimeInState ( int  state) const
Parameters
statethe wifi state
Returns
the time the radio can stay in that state based on the remaining energy.

Definition at line 271 of file wifi-radio-energy-model.cc.

References GetStateA(), m_source, NS_FATAL_ERROR, OFF, and ns3::Seconds().

Referenced by ChangeState(), HandleEnergyChanged(), and SetEnergySource().

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

◆ GetPhyListener()

WifiRadioEnergyModelPhyListener * ns3::WifiRadioEnergyModel::GetPhyListener ( void  )
Returns
Pointer to the PHY listener.

Definition at line 379 of file wifi-radio-energy-model.cc.

References m_listener, and NS_LOG_FUNCTION.

◆ GetRxCurrentA()

double ns3::WifiRadioEnergyModel::GetRxCurrentA ( void  ) const

Gets receive current.

Returns
receive current of the wifi device.

Definition at line 183 of file wifi-radio-energy-model.cc.

References m_rxCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetSleepCurrentA()

double ns3::WifiRadioEnergyModel::GetSleepCurrentA ( void  ) const

Gets sleep current.

Returns
sleep current of the wifi device.

Definition at line 211 of file wifi-radio-energy-model.cc.

References m_sleepCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetStateA()

double ns3::WifiRadioEnergyModel::GetStateA ( int  state) const
private
Parameters
statethe wifi state
Returns
draw of device, at given state.

Definition at line 398 of file wifi-radio-energy-model.cc.

References CCA_BUSY, IDLE, m_ccaBusyCurrentA, m_idleCurrentA, m_rxCurrentA, m_sleepCurrentA, m_switchingCurrentA, m_txCurrentA, NS_FATAL_ERROR, OFF, RX, SLEEP, SWITCHING, and TX.

Referenced by ChangeState(), DoGetCurrentA(), GetMaximumTimeInState(), and GetTotalEnergyConsumption().

+ Here is the caller graph for this function:

◆ GetSwitchingCurrentA()

double ns3::WifiRadioEnergyModel::GetSwitchingCurrentA ( void  ) const

Gets switching current.

Returns
switching current of the wifi device.

Definition at line 197 of file wifi-radio-energy-model.cc.

References m_switchingCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetTotalEnergyConsumption()

double ns3::WifiRadioEnergyModel::GetTotalEnergyConsumption ( void  ) const
virtual
Returns
Total energy consumption of the wifi device.

Implements DeviceEnergyModel::GetTotalEnergyConsumption.

Implements ns3::DeviceEnergyModel.

Definition at line 123 of file wifi-radio-energy-model.cc.

References ns3::Time::GetSeconds(), GetStateA(), ns3::Time::IsPositive(), m_currentState, m_lastUpdateTime, m_source, m_totalEnergyConsumption, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTxCurrentA()

double ns3::WifiRadioEnergyModel::GetTxCurrentA ( void  ) const

Gets transmit current.

Returns
transmit current of the wifi device.

Definition at line 169 of file wifi-radio-energy-model.cc.

References m_txCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ HandleEnergyChanged()

void ns3::WifiRadioEnergyModel::HandleEnergyChanged ( void  )
virtual

◆ HandleEnergyDepletion()

void ns3::WifiRadioEnergyModel::HandleEnergyDepletion ( void  )
virtual

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::DeviceEnergyModel.

Definition at line 342 of file wifi-radio-energy-model.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_energyDepletionCallback, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ HandleEnergyRecharged()

void ns3::WifiRadioEnergyModel::HandleEnergyRecharged ( void  )
virtual

Handles energy recharged.

Implements DeviceEnergyModel::HandleEnergyRecharged

Implements ns3::DeviceEnergyModel.

Definition at line 354 of file wifi-radio-energy-model.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_energyRechargedCallback, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetCcaBusyCurrentA()

void ns3::WifiRadioEnergyModel::SetCcaBusyCurrentA ( double  ccaBusyCurrentA)

Sets CCA busy current.

Parameters
ccaBusyCurrentAthe CCA busy current

Definition at line 162 of file wifi-radio-energy-model.cc.

References m_ccaBusyCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetEnergyDepletionCallback()

void ns3::WifiRadioEnergyModel::SetEnergyDepletionCallback ( WifiRadioEnergyDepletionCallback  callback)
Parameters
callbackCallback function.

Sets callback for energy depletion handling.

Definition at line 232 of file wifi-radio-energy-model.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_energyDepletionCallback, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetEnergyRechargedCallback()

void ns3::WifiRadioEnergyModel::SetEnergyRechargedCallback ( WifiRadioEnergyRechargedCallback  callback)
Parameters
callbackCallback function.

Sets callback for energy recharged handling.

Definition at line 244 of file wifi-radio-energy-model.cc.

References ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_energyRechargedCallback, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetEnergySource()

void ns3::WifiRadioEnergyModel::SetEnergySource ( const Ptr< EnergySource source)
virtual

Sets pointer to EnergySouce installed on node.

Parameters
sourcePointer to EnergySource installed on node.

Implements DeviceEnergyModel::SetEnergySource.

Implements ns3::DeviceEnergyModel.

Definition at line 112 of file wifi-radio-energy-model.cc.

References ns3::EventId::Cancel(), ChangeState(), GetMaximumTimeInState(), m_currentState, m_source, m_switchToOffEvent, NS_ASSERT, NS_LOG_FUNCTION, OFF, and ns3::Simulator::Schedule().

Referenced by BasicEnergyUpdateTest::StateSwitchTest().

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

◆ SetIdleCurrentA()

void ns3::WifiRadioEnergyModel::SetIdleCurrentA ( double  idleCurrentA)

Sets idle current.

Parameters
idleCurrentAthe idle current

Definition at line 148 of file wifi-radio-energy-model.cc.

References m_idleCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and BatteryLifetimeTest::VariableLoadTest().

+ Here is the caller graph for this function:

◆ SetRxCurrentA()

void ns3::WifiRadioEnergyModel::SetRxCurrentA ( double  rxCurrentA)

Sets receive current.

Parameters
rxCurrentAthe receive current

Definition at line 190 of file wifi-radio-energy-model.cc.

References m_rxCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSleepCurrentA()

void ns3::WifiRadioEnergyModel::SetSleepCurrentA ( double  sleepCurrentA)

Sets sleep current.

Parameters
sleepCurrentAthe sleep current

Definition at line 218 of file wifi-radio-energy-model.cc.

References m_sleepCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSwitchingCurrentA()

void ns3::WifiRadioEnergyModel::SetSwitchingCurrentA ( double  switchingCurrentA)

Sets switching current.

Parameters
switchingCurrentAthe switching current

Definition at line 204 of file wifi-radio-energy-model.cc.

References m_switchingCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetTxCurrentA()

void ns3::WifiRadioEnergyModel::SetTxCurrentA ( double  txCurrentA)

Sets transmit current.

Parameters
txCurrentAthe transmit current

Definition at line 176 of file wifi-radio-energy-model.cc.

References m_txCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetTxCurrentFromModel()

void ns3::WifiRadioEnergyModel::SetTxCurrentFromModel ( double  txPowerDbm)

Calls the CalcTxCurrent method of the tx current model to compute the tx current based on such model.

Parameters
txPowerDbmthe nominal tx power in dBm

Definition at line 262 of file wifi-radio-energy-model.cc.

References m_txCurrentA, and m_txCurrentModel.

Referenced by WifiRadioEnergyModel().

+ Here is the caller graph for this function:

◆ SetTxCurrentModel()

void ns3::WifiRadioEnergyModel::SetTxCurrentModel ( const Ptr< WifiTxCurrentModel model)
Parameters
modelthe model used to compute the wifi tx current.

Definition at line 256 of file wifi-radio-energy-model.cc.

References m_txCurrentModel.

◆ SetWifiRadioState()

void ns3::WifiRadioEnergyModel::SetWifiRadioState ( const WifiPhyState  state)
private
Parameters
stateNew state the radio device is currently in.

Sets current state. This function is private so that only the energy model can change its own state.

Definition at line 427 of file wifi-radio-energy-model.cc.

References CCA_BUSY, IDLE, m_currentState, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, OFF, RX, SLEEP, SWITCHING, and TX.

Referenced by ChangeState().

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

Member Data Documentation

◆ m_ccaBusyCurrentA

double ns3::WifiRadioEnergyModel::m_ccaBusyCurrentA
private

CCA busy current.

Definition at line 429 of file wifi-radio-energy-model.h.

Referenced by GetCcaBusyCurrentA(), GetStateA(), and SetCcaBusyCurrentA().

◆ m_currentState

WifiPhyState ns3::WifiRadioEnergyModel::m_currentState
private

◆ m_energyDepletionCallback

WifiRadioEnergyDepletionCallback ns3::WifiRadioEnergyModel::m_energyDepletionCallback
private

Energy depletion callback.

Definition at line 444 of file wifi-radio-energy-model.h.

Referenced by DoDispose(), HandleEnergyDepletion(), SetEnergyDepletionCallback(), and WifiRadioEnergyModel().

◆ m_energyRechargedCallback

WifiRadioEnergyRechargedCallback ns3::WifiRadioEnergyModel::m_energyRechargedCallback
private

Energy recharged callback.

Definition at line 447 of file wifi-radio-energy-model.h.

Referenced by HandleEnergyRecharged(), and SetEnergyRechargedCallback().

◆ m_idleCurrentA

double ns3::WifiRadioEnergyModel::m_idleCurrentA
private

idle current

Definition at line 428 of file wifi-radio-energy-model.h.

Referenced by GetIdleCurrentA(), GetStateA(), and SetIdleCurrentA().

◆ m_lastUpdateTime

Time ns3::WifiRadioEnergyModel::m_lastUpdateTime
private

time stamp of previous energy update

Definition at line 439 of file wifi-radio-energy-model.h.

Referenced by ChangeState(), and GetTotalEnergyConsumption().

◆ m_listener

WifiRadioEnergyModelPhyListener* ns3::WifiRadioEnergyModel::m_listener
private

WifiPhy listener.

Definition at line 450 of file wifi-radio-energy-model.h.

Referenced by GetPhyListener(), WifiRadioEnergyModel(), and ~WifiRadioEnergyModel().

◆ m_nPendingChangeState

uint8_t ns3::WifiRadioEnergyModel::m_nPendingChangeState
private

pending state change

Definition at line 441 of file wifi-radio-energy-model.h.

Referenced by ChangeState().

◆ m_rxCurrentA

double ns3::WifiRadioEnergyModel::m_rxCurrentA
private

receive current

Definition at line 427 of file wifi-radio-energy-model.h.

Referenced by GetRxCurrentA(), GetStateA(), and SetRxCurrentA().

◆ m_sleepCurrentA

double ns3::WifiRadioEnergyModel::m_sleepCurrentA
private

sleep current

Definition at line 431 of file wifi-radio-energy-model.h.

Referenced by GetSleepCurrentA(), GetStateA(), and SetSleepCurrentA().

◆ m_source

Ptr<EnergySource> ns3::WifiRadioEnergyModel::m_source
private

◆ m_switchingCurrentA

double ns3::WifiRadioEnergyModel::m_switchingCurrentA
private

switching current

Definition at line 430 of file wifi-radio-energy-model.h.

Referenced by GetStateA(), GetSwitchingCurrentA(), and SetSwitchingCurrentA().

◆ m_switchToOffEvent

EventId ns3::WifiRadioEnergyModel::m_switchToOffEvent
private

switch to off event

Definition at line 452 of file wifi-radio-energy-model.h.

Referenced by ChangeState(), HandleEnergyChanged(), and SetEnergySource().

◆ m_totalEnergyConsumption

TracedValue<double> ns3::WifiRadioEnergyModel::m_totalEnergyConsumption
private

This variable keeps track of the total energy consumed by this model.

Definition at line 435 of file wifi-radio-energy-model.h.

Referenced by ChangeState(), GetTotalEnergyConsumption(), and GetTypeId().

◆ m_txCurrentA

double ns3::WifiRadioEnergyModel::m_txCurrentA
private

transmit current

Definition at line 426 of file wifi-radio-energy-model.h.

Referenced by GetStateA(), GetTxCurrentA(), SetTxCurrentA(), and SetTxCurrentFromModel().

◆ m_txCurrentModel

Ptr<WifiTxCurrentModel> ns3::WifiRadioEnergyModel::m_txCurrentModel
private

current model

Definition at line 432 of file wifi-radio-energy-model.h.

Referenced by GetTypeId(), SetTxCurrentFromModel(), SetTxCurrentModel(), and ~WifiRadioEnergyModel().


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