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 ()
 
virtual void ChangeState (int newState)
 Changes state of the WifiRadioEnergyMode. More...
 
double GetCcaBusyCurrentA (void) const
 
WifiPhy::State GetCurrentState (void) const
 
double GetIdleCurrentA (void) const
 
WifiRadioEnergyModelPhyListenerGetPhyListener (void)
 
double GetRxCurrentA (void) const
 
double GetSleepCurrentA (void) const
 
double GetSwitchingCurrentA (void) const
 
virtual double GetTotalEnergyConsumption (void) const
 
double GetTxCurrentA (void) const
 
virtual void HandleEnergyDepletion (void)
 Handles energy depletion. More...
 
virtual void HandleEnergyRecharged (void)
 Handles energy recharged. More...
 
void SetCcaBusyCurrentA (double ccaBusyCurrentA)
 
void SetEnergyDepletionCallback (WifiRadioEnergyDepletionCallback callback)
 
void SetEnergyRechargedCallback (WifiRadioEnergyRechargedCallback callback)
 
virtual void SetEnergySource (Ptr< EnergySource > source)
 Sets pointer to EnergySouce installed on node. More...
 
void SetIdleCurrentA (double idleCurrentA)
 
void SetRxCurrentA (double rxCurrentA)
 
void SetSleepCurrentA (double sleepCurrentA)
 
void SetSwitchingCurrentA (double switchingCurrentA)
 
void SetTxCurrentA (double txCurrentA)
 
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 (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
 Implement the GetInstanceTypeId method defined in ObjectBase. 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 ()
 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
 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)
 
- 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::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...
 

Private Member Functions

void DoDispose (void)
 Destructor implementation. More...
 
virtual double DoGetCurrentA (void) const
 
void SetWifiRadioState (const WifiPhy::State state)
 

Private Attributes

double m_ccaBusyCurrentA
 
WifiPhy::State m_currentState
 
WifiRadioEnergyDepletionCallback m_energyDepletionCallback
 
WifiRadioEnergyRechargedCallback m_energyRechargedCallback
 
double m_idleCurrentA
 
bool m_isSupersededChangeState
 
Time m_lastUpdateTime
 
WifiRadioEnergyModelPhyListenerm_listener
 
uint8_t m_nPendingChangeState
 
double m_rxCurrentA
 
double m_sleepCurrentA
 
Ptr< EnergySourcem_source
 
double m_switchingCurrentA
 
TracedValue< double > m_totalEnergyConsumption
 
double m_txCurrentA
 
Ptr< WifiTxCurrentModelm_txCurrentModel
 

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 168 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

Callback type for energy depletion handling.

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

Callback type for energy recharged handling.

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

Constructor & Destructor Documentation

ns3::WifiRadioEnergyModel::~WifiRadioEnergyModel ( )
virtual

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

References m_listener, and NS_LOG_FUNCTION.

Member Function Documentation

void ns3::WifiRadioEnergyModel::ChangeState ( int  newState)
virtual
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 overriden 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 362 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:

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

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

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

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

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

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

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

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

References m_listener, and NS_LOG_FUNCTION.

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

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

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

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

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

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

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

Implements DeviceEnergyModel::GetTotalEnergyConsumption.

Implements ns3::DeviceEnergyModel.

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

References m_totalEnergyConsumption, and NS_LOG_FUNCTION.

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

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

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

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::DeviceEnergyModel.

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

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

Handles energy recharged.

Implements DeviceEnergyModel::HandleEnergyRecharged

Implements ns3::DeviceEnergyModel.

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

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

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

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

Sets callback for energy depletion handling.

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

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

Sets callback for energy recharged 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_energyRechargedCallback, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::WifiRadioEnergyModel::SetEnergySource ( 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 114 of file wifi-radio-energy-model.cc.

References m_source, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by BasicEnergyUpdateTest::StateSwitchTest().

+ Here is the caller graph for this function:

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

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

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

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

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

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

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

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

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

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

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 250 of file wifi-radio-energy-model.cc.

References m_txCurrentA, and m_txCurrentModel.

Referenced by WifiRadioEnergyModel().

+ Here is the caller graph for this function:

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

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

References m_txCurrentModel.

void ns3::WifiRadioEnergyModel::SetWifiRadioState ( const WifiPhy::State  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 393 of file wifi-radio-energy-model.cc.

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

Referenced by ChangeState().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

double ns3::WifiRadioEnergyModel::m_ccaBusyCurrentA
private
WifiPhy::State ns3::WifiRadioEnergyModel::m_currentState
private
WifiRadioEnergyDepletionCallback ns3::WifiRadioEnergyModel::m_energyDepletionCallback
private
WifiRadioEnergyRechargedCallback ns3::WifiRadioEnergyModel::m_energyRechargedCallback
private

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

Referenced by HandleEnergyRecharged(), and SetEnergyRechargedCallback().

double ns3::WifiRadioEnergyModel::m_idleCurrentA
private
bool ns3::WifiRadioEnergyModel::m_isSupersededChangeState
private

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

Referenced by ChangeState(), and WifiRadioEnergyModel().

Time ns3::WifiRadioEnergyModel::m_lastUpdateTime
private

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

Referenced by ChangeState(), and WifiRadioEnergyModel().

WifiRadioEnergyModelPhyListener* ns3::WifiRadioEnergyModel::m_listener
private
uint8_t ns3::WifiRadioEnergyModel::m_nPendingChangeState
private

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

Referenced by ChangeState(), and WifiRadioEnergyModel().

double ns3::WifiRadioEnergyModel::m_rxCurrentA
private
double ns3::WifiRadioEnergyModel::m_sleepCurrentA
private
Ptr<EnergySource> ns3::WifiRadioEnergyModel::m_source
private
double ns3::WifiRadioEnergyModel::m_switchingCurrentA
private
TracedValue<double> ns3::WifiRadioEnergyModel::m_totalEnergyConsumption
private

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

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

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

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

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


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