A WiFi radio energy model. More...

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

Inheritance 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

WifiRadioEnergyModelPhyListener *	GetPhyListener (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...

SimpleRefCount &	operator= (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

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...

WifiRadioEnergyModelPhyListener *	m_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< EnergySource >	m_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< WifiTxCurrentModel >	m_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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. 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:

Tx: State goes from IDLE to TX, radio is in TX state for TX_duration, then state goes from TX to IDLE.
Rx: State goes from IDLE to RX, radio is in RX state for RX_duration, then state goes from RX to IDLE.
Go_to_Sleep: State goes from IDLE to SLEEP.
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.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::WifiTxCurrentModel>
- Initial value: 0x0
- Flags: construct write read

TraceSources

TotalEnergyConsumption: Total energy consumption of the radio device.
Callback signature: ns3::TracedValueCallback::Double

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

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

Member Typedef Documentation

◆ WifiRadioEnergyDepletionCallback

typedef Callback<void> ns3::WifiRadioEnergyModel::WifiRadioEnergyDepletionCallback

Callback type for energy depletion handling.

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

◆ WifiRadioEnergyRechargedCallback

typedef Callback<void> ns3::WifiRadioEnergyModel::WifiRadioEnergyRechargedCallback

Callback type for energy recharged handling.

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

Constructor & Destructor Documentation

◆ WifiRadioEnergyModel()

ns3::WifiRadioEnergyModel::WifiRadioEnergyModel ( )

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

References ns3::DeviceEnergyModel::ChangeState(), m_energyDepletionCallback, m_listener, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::Nullify(), ns3::WifiRadioEnergyModelPhyListener::SetChangeStateCallback(), SetTxCurrentFromModel(), and ns3::WifiRadioEnergyModelPhyListener::SetUpdateTxCurrentCallback().

◆ ~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

Changes state of the WifiRadioEnergyMode.

Parameters

newState New state the wifi radio is in.

Implements DeviceEnergyModel::ChangeState.

Implements ns3::DeviceEnergyModel.

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

References ns3::EventId::Cancel(), CCA_BUSY, GetMaximumTimeInState(), ns3::Time::GetNanoSeconds(), IDLE, ns3::Time::IsPositive(), m_ccaBusyCurrentA, m_currentState, m_idleCurrentA, m_lastUpdateTime, m_nPendingChangeState, m_rxCurrentA, m_sleepCurrentA, m_source, m_switchingCurrentA, m_switchToOffEvent, m_totalEnergyConsumption, m_txCurrentA, ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, OFF, RX, ns3::Simulator::Schedule(), SetWifiRadioState(), SLEEP, SWITCHING, and TX.

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

◆ 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 461 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().

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

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

◆ GetCcaBusyCurrentA()

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

Gets CCA busy current.

Returns: CCA Busy current of the wifi device.

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

References m_ccaBusyCurrentA, and NS_LOG_FUNCTION.

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

◆ GetCurrentState()

WifiPhyState ns3::WifiRadioEnergyModel::GetCurrentState ( void ) const

Returns: Current state.

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

References m_currentState, and NS_LOG_FUNCTION.

Referenced by BasicEnergyUpdateTest::StateSwitchTest().

◆ GetIdleCurrentA()

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

Gets idle current.

Returns: idle current of the wifi device.

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

References m_idleCurrentA, and NS_LOG_FUNCTION.

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

◆ GetMaximumTimeInState()

Time ns3::WifiRadioEnergyModel::GetMaximumTimeInState ( int state ) const

Parameters

state the wifi state

Returns: the time the radio can stay in that state based on the remaining energy.

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

References CCA_BUSY, IDLE, m_ccaBusyCurrentA, m_idleCurrentA, m_rxCurrentA, m_sleepCurrentA, m_source, m_switchingCurrentA, m_txCurrentA, ns3::NanoSeconds(), NS_FATAL_ERROR, RX, SLEEP, SWITCHING, and TX.

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

◆ GetPhyListener()

WifiRadioEnergyModelPhyListener * ns3::WifiRadioEnergyModel::GetPhyListener ( void )

Returns: Pointer to the PHY listener.

Definition at line 450 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 209 of file wifi-radio-energy-model.cc.

References m_rxCurrentA, and NS_LOG_FUNCTION.

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

◆ GetSleepCurrentA()

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

Gets sleep current.

Returns: sleep current of the wifi device.

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

References m_sleepCurrentA, and NS_LOG_FUNCTION.

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

◆ GetSwitchingCurrentA()

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

Gets switching current.

Returns: switching current of the wifi device.

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

References m_switchingCurrentA, and NS_LOG_FUNCTION.

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

◆ 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 CCA_BUSY, ns3::Time::GetNanoSeconds(), ns3::Time::GetSeconds(), IDLE, m_ccaBusyCurrentA, m_currentState, m_idleCurrentA, m_lastUpdateTime, m_rxCurrentA, m_sleepCurrentA, m_source, m_switchingCurrentA, m_totalEnergyConsumption, m_txCurrentA, ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, OFF, RX, SLEEP, SWITCHING, and TX.

◆ GetTxCurrentA()

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

Gets transmit current.

Returns: transmit current of the wifi device.

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

References m_txCurrentA, and NS_LOG_FUNCTION.

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

◆ GetTypeId()

TypeId ns3::WifiRadioEnergyModel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References GetCcaBusyCurrentA(), GetIdleCurrentA(), GetRxCurrentA(), GetSleepCurrentA(), GetSwitchingCurrentA(), GetTxCurrentA(), m_totalEnergyConsumption, m_txCurrentModel, ns3::MakeDoubleAccessor(), ns3::MakePointerAccessor(), ns3::MakeTraceSourceAccessor(), SetCcaBusyCurrentA(), SetIdleCurrentA(), ns3::TypeId::SetParent(), SetRxCurrentA(), SetSleepCurrentA(), SetSwitchingCurrentA(), and SetTxCurrentA().

◆ HandleEnergyChanged()

void ns3::WifiRadioEnergyModel::HandleEnergyChanged ( void )

virtual

Handles energy changed.

Implements DeviceEnergyModel::HandleEnergyChanged

Implements ns3::DeviceEnergyModel.

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

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

◆ HandleEnergyDepletion()

void ns3::WifiRadioEnergyModel::HandleEnergyDepletion ( void )

virtual

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::DeviceEnergyModel.

Definition at line 413 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.

◆ HandleEnergyRecharged()

void ns3::WifiRadioEnergyModel::HandleEnergyRecharged ( void )

virtual

Handles energy recharged.

Implements DeviceEnergyModel::HandleEnergyRecharged

Implements ns3::DeviceEnergyModel.

Definition at line 425 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.

◆ SetCcaBusyCurrentA()

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

Sets CCA busy current.

Parameters

ccaBusyCurrentA the CCA busy current

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

References m_ccaBusyCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

◆ SetEnergyDepletionCallback()

void ns3::WifiRadioEnergyModel::SetEnergyDepletionCallback ( WifiRadioEnergyDepletionCallback callback )

Parameters

callback Callback function.

Sets callback for energy depletion handling.

Definition at line 258 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.

◆ SetEnergyRechargedCallback()

void ns3::WifiRadioEnergyModel::SetEnergyRechargedCallback ( WifiRadioEnergyRechargedCallback callback )

Parameters

callback Callback function.

Sets callback for energy recharged handling.

Definition at line 270 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.

◆ SetEnergySource()

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

virtual

Sets pointer to EnergySouce installed on node.

Parameters

source Pointer 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().

◆ SetIdleCurrentA()

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

Sets idle current.

Parameters

idleCurrentA the idle current

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

References m_idleCurrentA, and NS_LOG_FUNCTION.

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

◆ SetRxCurrentA()

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

Sets receive current.

Parameters

rxCurrentA the receive current

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

References m_rxCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

◆ SetSleepCurrentA()

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

Sets sleep current.

Parameters

sleepCurrentA the sleep current

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

References m_sleepCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

◆ SetSwitchingCurrentA()

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

Sets switching current.

Parameters

switchingCurrentA the switching current

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

References m_switchingCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

◆ SetTxCurrentA()

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

Sets transmit current.

Parameters

txCurrentA the transmit current

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

References m_txCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

◆ 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

txPowerDbm the nominal tx power in dBm

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

References m_txCurrentA, and m_txCurrentModel.

Referenced by WifiRadioEnergyModel().

◆ SetTxCurrentModel()

void ns3::WifiRadioEnergyModel::SetTxCurrentModel ( const Ptr< WifiTxCurrentModel > model )

Parameters

model the model used to compute the wifi tx current.

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

References m_txCurrentModel.

◆ SetWifiRadioState()

void ns3::WifiRadioEnergyModel::SetWifiRadioState ( const WifiPhyState state )

private

Parameters

state New 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 493 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().

Member Data Documentation

◆ m_ccaBusyCurrentA

double ns3::WifiRadioEnergyModel::m_ccaBusyCurrentA

private

CCA busy current.

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

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

◆ m_currentState

WifiPhyState ns3::WifiRadioEnergyModel::m_currentState

private

current state the radio is in

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

Referenced by ChangeState(), DoGetCurrentA(), GetCurrentState(), GetTotalEnergyConsumption(), HandleEnergyChanged(), SetEnergySource(), and SetWifiRadioState().

◆ m_energyDepletionCallback

WifiRadioEnergyDepletionCallback ns3::WifiRadioEnergyModel::m_energyDepletionCallback

private

Energy depletion callback.

Definition at line 438 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 441 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 422 of file wifi-radio-energy-model.h.

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

◆ m_lastUpdateTime

Time ns3::WifiRadioEnergyModel::m_lastUpdateTime

private

time stamp of previous energy update

Definition at line 433 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 444 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 435 of file wifi-radio-energy-model.h.

Referenced by ChangeState().

◆ m_rxCurrentA

double ns3::WifiRadioEnergyModel::m_rxCurrentA

private

receive current

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

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

◆ m_sleepCurrentA

double ns3::WifiRadioEnergyModel::m_sleepCurrentA

private

sleep current

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

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

◆ m_source

Ptr<EnergySource> ns3::WifiRadioEnergyModel::m_source

private

energy source

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

Referenced by ChangeState(), DoDispose(), GetMaximumTimeInState(), GetTotalEnergyConsumption(), and SetEnergySource().

◆ m_switchingCurrentA

double ns3::WifiRadioEnergyModel::m_switchingCurrentA

private

switching current

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

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

◆ m_switchToOffEvent

EventId ns3::WifiRadioEnergyModel::m_switchToOffEvent

private

switch to off event

Definition at line 446 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 429 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 420 of file wifi-radio-energy-model.h.

Referenced by ChangeState(), DoGetCurrentA(), GetMaximumTimeInState(), GetTotalEnergyConsumption(), GetTxCurrentA(), SetTxCurrentA(), and SetTxCurrentFromModel().

◆ m_txCurrentModel

Ptr<WifiTxCurrentModel> ns3::WifiRadioEnergyModel::m_txCurrentModel

private

current model

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

src/wifi/model/wifi-radio-energy-model.h
src/wifi/model/wifi-radio-energy-model.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

TraceSources

Member Typedef Documentation

◆ WifiRadioEnergyDepletionCallback

◆ WifiRadioEnergyRechargedCallback

Constructor & Destructor Documentation

◆ WifiRadioEnergyModel()

◆ ~WifiRadioEnergyModel()

Member Function Documentation

◆ ChangeState()

◆ DoDispose()

◆ DoGetCurrentA()

◆ GetCcaBusyCurrentA()

◆ GetCurrentState()

◆ GetIdleCurrentA()

◆ GetMaximumTimeInState()

◆ GetPhyListener()

◆ GetRxCurrentA()

◆ GetSleepCurrentA()

◆ GetSwitchingCurrentA()

◆ GetTotalEnergyConsumption()

◆ GetTxCurrentA()

◆ GetTypeId()

◆ HandleEnergyChanged()

◆ HandleEnergyDepletion()

◆ HandleEnergyRecharged()

◆ SetCcaBusyCurrentA()

◆ SetEnergyDepletionCallback()

◆ SetEnergyRechargedCallback()

◆ SetEnergySource()

◆ SetIdleCurrentA()

◆ SetRxCurrentA()

◆ SetSleepCurrentA()

◆ SetSwitchingCurrentA()

◆ SetTxCurrentA()

◆ SetTxCurrentFromModel()

◆ SetTxCurrentModel()

◆ SetWifiRadioState()

Member Data Documentation

◆ m_ccaBusyCurrentA

◆ m_currentState

◆ m_energyDepletionCallback

◆ m_energyRechargedCallback

◆ m_idleCurrentA

◆ m_lastUpdateTime

◆ m_listener

◆ m_nPendingChangeState

◆ m_rxCurrentA

◆ m_sleepCurrentA

◆ m_source

◆ m_switchingCurrentA

◆ m_switchToOffEvent

◆ m_totalEnergyConsumption

◆ m_txCurrentA

◆ m_txCurrentModel