A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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.
 
typedef Callback< void > WifiRadioEnergyRechargedCallback
 Callback type for energy recharged handling.
 
- Public Types inherited from ns3::energy::DeviceEnergyModel
typedef Callback< void, int > ChangeStateCallback
 Callback type for ChangeState function.
 

Public Member Functions

 WifiRadioEnergyModel ()
 
 ~WifiRadioEnergyModel () override
 
void ChangeState (int newState) override
 Changes state of the WifiRadioEnergyMode.
 
ampere_u GetCcaBusyCurrentA () const
 Gets CCA busy current.
 
WifiPhyState GetCurrentState () const
 
ampere_u GetIdleCurrentA () const
 Gets idle current.
 
Time GetMaximumTimeInState (WifiPhyState state) const
 
std::shared_ptr< WifiRadioEnergyModelPhyListenerGetPhyListener ()
 
ampere_u GetRxCurrentA () const
 Gets receive current.
 
ampere_u GetSleepCurrentA () const
 Gets sleep current.
 
ampere_u GetSwitchingCurrentA () const
 Gets switching current.
 
Watt_u GetTotalEnergyConsumption () const override
 
ampere_u GetTxCurrentA () const
 Gets transmit current.
 
void HandleEnergyChanged () override
 Handles energy changed.
 
void HandleEnergyDepletion () override
 Handles energy depletion.
 
void HandleEnergyRecharged () override
 Handles energy recharged.
 
void SetCcaBusyCurrentA (ampere_u ccaBusyCurrentA)
 Sets CCA busy current.
 
void SetEnergyDepletionCallback (WifiRadioEnergyDepletionCallback callback)
 
void SetEnergyRechargedCallback (WifiRadioEnergyRechargedCallback callback)
 
void SetEnergySource (const Ptr< energy::EnergySource > source) override
 Sets pointer to EnergySource installed on node.
 
void SetIdleCurrentA (ampere_u idleCurrentA)
 Sets idle current.
 
void SetRxCurrentA (ampere_u rxCurrentA)
 Sets receive current.
 
void SetSleepCurrentA (ampere_u sleepCurrentA)
 Sets sleep current.
 
void SetSwitchingCurrentA (ampere_u switchingCurrentA)
 Sets switching current.
 
void SetTxCurrentA (ampere_u txCurrentA)
 Sets transmit current.
 
void SetTxCurrentFromModel (dBm_u txPower)
 Calls the CalcTxCurrent method of the TX current model to compute the TX current based on such model.
 
void SetTxCurrentModel (const Ptr< WifiTxCurrentModel > model)
 
- Public Member Functions inherited from ns3::energy::DeviceEnergyModel
 DeviceEnergyModel ()
 
 ~DeviceEnergyModel () override
 
double GetCurrentA () const
 
- 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.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
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, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

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

void DoDispose () override
 Destructor implementation.
 
ampere_u DoGetCurrentA () const override
 
ampere_u GetStateA (WifiPhyState state) const
 
void SetWifiRadioState (const WifiPhyState state)
 

Private Attributes

ampere_u m_ccaBusyCurrent
 CCA busy current.
 
WifiPhyState m_currentState
 current state the radio is in
 
WifiRadioEnergyDepletionCallback m_energyDepletionCallback
 Energy depletion callback.
 
WifiRadioEnergyRechargedCallback m_energyRechargedCallback
 Energy recharged callback.
 
ampere_u m_idleCurrent
 idle current
 
Time m_lastUpdateTime
 time stamp of previous energy update
 
std::shared_ptr< WifiRadioEnergyModelPhyListenerm_listener
 WifiPhy listener.
 
uint8_t m_nPendingChangeState
 pending state change
 
ampere_u m_rxCurrent
 receive current
 
ampere_u m_sleepCurrent
 sleep current
 
Ptr< energy::EnergySourcem_source
 energy source
 
ampere_u m_switchingCurrent
 switching current
 
EventId m_switchToOffEvent
 switch to off event
 
TracedValue< doublem_totalEnergyConsumption
 This variable keeps track of the total energy consumed by this model in watts.
 
ampere_u m_txCurrent
 transmit current
 
Ptr< WifiTxCurrentModelm_txCurrentModel
 current model
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
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

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

  • 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: constructwriteread
    • Support level: SUPPORTED
  • 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: constructwriteread
    • Support level: SUPPORTED
  • 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: constructwriteread
    • Support level: SUPPORTED
  • 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: constructwriteread
    • Support level: SUPPORTED
  • 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: constructwriteread
    • Support level: SUPPORTED
  • 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: constructwriteread
    • Support level: SUPPORTED
  • TxCurrentModel: A pointer to the attached TX current model.

TraceSources

Group: Energy

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

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

Member Typedef Documentation

◆ WifiRadioEnergyDepletionCallback

Callback type for energy depletion handling.

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

◆ WifiRadioEnergyRechargedCallback

Callback type for energy recharged handling.

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

Constructor & Destructor Documentation

◆ WifiRadioEnergyModel()

ns3::WifiRadioEnergyModel::WifiRadioEnergyModel ( )

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

References m_energyDepletionCallback, m_listener, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::Callback< R, UArgs >::Nullify(), and SetTxCurrentFromModel().

+ Here is the call graph for this function:

◆ ~WifiRadioEnergyModel()

ns3::WifiRadioEnergyModel::~WifiRadioEnergyModel ( )
override

Definition at line 98 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)
overridevirtual

Changes state of the WifiRadioEnergyMode.

Parameters
newStateNew state the wifi radio is in.

Implements DeviceEnergyModel::ChangeState.

Implements ns3::energy::DeviceEnergyModel.

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

References ns3::EventId::Cancel(), ChangeState(), GetMaximumTimeInState(), GetStateA(), m_currentState, m_lastUpdateTime, m_nPendingChangeState, m_source, m_switchToOffEvent, m_totalEnergyConsumption, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::OFF, ns3::Simulator::Schedule(), and SetWifiRadioState().

Referenced by ChangeState(), HandleEnergyChanged(), SetEnergySource(), and BasicEnergyUpdateTest::StateSwitchTest().

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

◆ DoDispose()

void ns3::WifiRadioEnergyModel::DoDispose ( )
overrideprivatevirtual

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

References m_energyDepletionCallback, m_source, NS_LOG_FUNCTION, and ns3::Callback< R, UArgs >::Nullify().

+ Here is the call graph for this function:

◆ DoGetCurrentA()

ampere_u ns3::WifiRadioEnergyModel::DoGetCurrentA ( ) const
overrideprivatevirtual
Returns
Current draw of device at current state.

Implements DeviceEnergyModel::GetCurrentA.

Reimplemented from ns3::energy::DeviceEnergyModel.

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

References GetStateA(), and m_currentState.

+ Here is the call graph for this function:

◆ GetCcaBusyCurrentA()

ampere_u ns3::WifiRadioEnergyModel::GetCcaBusyCurrentA ( ) const

Gets CCA busy current.

Returns
CCA Busy current of the wifi device.

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

References m_ccaBusyCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetCurrentState()

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

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

References m_currentState, and NS_LOG_FUNCTION.

◆ GetIdleCurrentA()

ampere_u ns3::WifiRadioEnergyModel::GetIdleCurrentA ( ) const

Gets idle current.

Returns
idle current of the wifi device.

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

References m_idleCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetMaximumTimeInState()

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

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

References GetStateA(), m_source, NS_FATAL_ERROR, ns3::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()

std::shared_ptr< WifiRadioEnergyModelPhyListener > ns3::WifiRadioEnergyModel::GetPhyListener ( )
Returns
Pointer to the PHY listener.

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

References m_listener, and NS_LOG_FUNCTION.

◆ GetRxCurrentA()

ampere_u ns3::WifiRadioEnergyModel::GetRxCurrentA ( ) const

Gets receive current.

Returns
receive current of the wifi device.

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

References m_rxCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetSleepCurrentA()

ampere_u ns3::WifiRadioEnergyModel::GetSleepCurrentA ( ) const

Gets sleep current.

Returns
sleep current of the wifi device.

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

References m_sleepCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetStateA()

ampere_u ns3::WifiRadioEnergyModel::GetStateA ( WifiPhyState state) const
private
Parameters
statethe wifi state
Returns
draw of device at given state.

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

References ns3::CCA_BUSY, ns3::IDLE, m_ccaBusyCurrent, m_idleCurrent, m_rxCurrent, m_sleepCurrent, m_switchingCurrent, m_txCurrent, NS_FATAL_ERROR, ns3::OFF, ns3::RX, ns3::SLEEP, ns3::SWITCHING, and ns3::TX.

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

+ Here is the caller graph for this function:

◆ GetSwitchingCurrentA()

ampere_u ns3::WifiRadioEnergyModel::GetSwitchingCurrentA ( ) const

Gets switching current.

Returns
switching current of the wifi device.

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

References m_switchingCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTotalEnergyConsumption()

Watt_u ns3::WifiRadioEnergyModel::GetTotalEnergyConsumption ( ) const
overridevirtual
Returns
Total energy consumption of the wifi device.

Implements DeviceEnergyModel::GetTotalEnergyConsumption.

Implements ns3::energy::DeviceEnergyModel.

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

References GetStateA(), 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()

ampere_u ns3::WifiRadioEnergyModel::GetTxCurrentA ( ) const

Gets transmit current.

Returns
transmit current of the wifi device.

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

References m_txCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ HandleEnergyChanged()

void ns3::WifiRadioEnergyModel::HandleEnergyChanged ( )
overridevirtual

Handles energy changed.

Implements DeviceEnergyModel::HandleEnergyChanged

Implements ns3::energy::DeviceEnergyModel.

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

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

+ Here is the call graph for this function:

◆ HandleEnergyDepletion()

void ns3::WifiRadioEnergyModel::HandleEnergyDepletion ( )
overridevirtual

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::energy::DeviceEnergyModel.

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

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

+ Here is the call graph for this function:

◆ HandleEnergyRecharged()

void ns3::WifiRadioEnergyModel::HandleEnergyRecharged ( )
overridevirtual

Handles energy recharged.

Implements DeviceEnergyModel::HandleEnergyRecharged

Implements ns3::energy::DeviceEnergyModel.

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

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

+ Here is the call graph for this function:

◆ SetCcaBusyCurrentA()

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

Sets CCA busy current.

Parameters
ccaBusyCurrentAthe CCA busy current

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

References m_ccaBusyCurrent, 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 229 of file wifi-radio-energy-model.cc.

References ns3::Callback< R, UArgs >::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 240 of file wifi-radio-energy-model.cc.

References ns3::Callback< R, UArgs >::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< energy::EnergySource > source)
overridevirtual

Sets pointer to EnergySource installed on node.

Parameters
sourcePointer to EnergySource installed on node.

Implements DeviceEnergyModel::SetEnergySource.

Implements ns3::energy::DeviceEnergyModel.

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

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

+ Here is the call graph for this function:

◆ SetIdleCurrentA()

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

Sets idle current.

Parameters
idleCurrentAthe idle current

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

References m_idleCurrent, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ SetRxCurrentA()

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

Sets receive current.

Parameters
rxCurrentAthe receive current

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

References m_rxCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSleepCurrentA()

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

Sets sleep current.

Parameters
sleepCurrentAthe sleep current

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

References m_sleepCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetSwitchingCurrentA()

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

Sets switching current.

Parameters
switchingCurrentAthe switching current

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

References m_switchingCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetTxCurrentA()

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

Sets transmit current.

Parameters
txCurrentAthe transmit current

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

References m_txCurrent, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetTxCurrentFromModel()

void ns3::WifiRadioEnergyModel::SetTxCurrentFromModel ( dBm_u txPower)

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

Parameters
txPowerthe nominal TX power

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

References m_txCurrent, 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 251 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 429 of file wifi-radio-energy-model.cc.

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

Referenced by ChangeState().

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

Member Data Documentation

◆ m_ccaBusyCurrent

ampere_u ns3::WifiRadioEnergyModel::m_ccaBusyCurrent
private

CCA busy current.

Definition at line 355 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 370 of file wifi-radio-energy-model.h.

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

◆ m_energyRechargedCallback

WifiRadioEnergyRechargedCallback ns3::WifiRadioEnergyModel::m_energyRechargedCallback
private

Energy recharged callback.

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

Referenced by HandleEnergyRecharged(), and SetEnergyRechargedCallback().

◆ m_idleCurrent

ampere_u ns3::WifiRadioEnergyModel::m_idleCurrent
private

idle current

Definition at line 354 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 365 of file wifi-radio-energy-model.h.

Referenced by ChangeState(), and GetTotalEnergyConsumption().

◆ m_listener

std::shared_ptr<WifiRadioEnergyModelPhyListener> ns3::WifiRadioEnergyModel::m_listener
private

WifiPhy listener.

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

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

◆ m_nPendingChangeState

uint8_t ns3::WifiRadioEnergyModel::m_nPendingChangeState
private

pending state change

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

Referenced by ChangeState().

◆ m_rxCurrent

ampere_u ns3::WifiRadioEnergyModel::m_rxCurrent
private

receive current

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

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

◆ m_sleepCurrent

ampere_u ns3::WifiRadioEnergyModel::m_sleepCurrent
private

sleep current

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

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

◆ m_source

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

◆ m_switchingCurrent

ampere_u ns3::WifiRadioEnergyModel::m_switchingCurrent
private

switching current

Definition at line 356 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 378 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 in watts.

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

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

◆ m_txCurrent

ampere_u ns3::WifiRadioEnergyModel::m_txCurrent
private

transmit current

Definition at line 352 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 358 of file wifi-radio-energy-model.h.

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


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