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...
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
WifiRadioEnergyModelPhyListener *	GetPhyListener (void)
double	GetRxCurrentA (void) const
double	GetSwitchingCurrentA (void) const
virtual double	GetTotalEnergyConsumption (void) const
double	GetTxCurrentA (void) const
virtual void	HandleEnergyDepletion (void)
	Handles energy depletion. More...
void	SetCcaBusyCurrentA (double ccaBusyCurrentA)
void	SetEnergyDepletionCallback (WifiRadioEnergyDepletionCallback callback)
virtual void	SetEnergySource (Ptr< EnergySource > source)
	Sets pointer to EnergySouce installed on node. More...
void	SetIdleCurrentA (double idleCurrentA)
void	SetRxCurrentA (double rxCurrentA)
void	SetSwitchingCurrentA (double switchingCurrentA)
void	SetTxCurrentA (double txCurrentA)
Public Member Functions inherited from ns3::DeviceEnergyModel
	DeviceEnergyModel ()
virtual	~DeviceEnergyModel ()
double	GetCurrentA (void) const
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) const
	Decrement the reference count. More...
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::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)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
virtual double	DoGetCurrentA (void) const
void	SetWifiRadioState (const WifiPhy::State state)

Private Attributes
double	m_ccaBusyCurrentA
WifiPhy::State	m_currentState
WifiRadioEnergyDepletionCallback	m_energyDepletionCallback
double	m_idleCurrentA
Time	m_lastUpdateTime
WifiRadioEnergyModelPhyListener *	m_listener
double	m_rxCurrentA
Ptr< EnergySource >	m_source
double	m_switchingCurrentA
TracedValue< double >	m_totalEnergyConsumption
double	m_txCurrentA

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...
virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

A WiFi radio energy model.

Doxygen 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 CC2420 radio chip, with supply voltage as 2.5V and currents as 17.4 mA (TX), 18.8 mA (RX), 20 uA (sleep) and 426 uA (idle).

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.000426
  • 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.000426
  • 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.0174
  • 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.0197
  • 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.000426
  • Flags: construct write read

TraceSources

• TotalEnergyConsumption: Total energy consumption of the radio device.

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

Member Typedef Documentation

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

Callback type for energy depletion handling.

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

Constructor & Destructor Documentation

ns3::WifiRadioEnergyModel::WifiRadioEnergyModel

(

)

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

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

Here is the call graph for this function:

ns3::WifiRadioEnergyModel::~WifiRadioEnergyModel ( )

virtual

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

References m_listener, and NS_LOG_FUNCTION.

Member Function Documentation

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

References ns3::WifiPhy::CCA_BUSY, ns3::Time::GetNanoSeconds(), ns3::Time::GetSeconds(), ns3::WifiPhy::IDLE, m_ccaBusyCurrentA, m_currentState, m_idleCurrentA, m_lastUpdateTime, m_rxCurrentA, m_source, m_switchingCurrentA, m_totalEnergyConsumption, m_txCurrentA, ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiPhy::RX, SetWifiRadioState(), ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

Here is the call graph for this function:

void ns3::WifiRadioEnergyModel::DoDispose ( void  )

privatevirtual

This method is called by Object::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 273 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

Returns

Current draw of device, at current state.

Implements DeviceEnergyModel::GetCurrentA.

Reimplemented from ns3::DeviceEnergyModel.

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

References ns3::WifiPhy::CCA_BUSY, ns3::WifiPhy::IDLE, m_ccaBusyCurrentA, m_currentState, m_idleCurrentA, m_rxCurrentA, m_switchingCurrentA, m_txCurrentA, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

double ns3::WifiRadioEnergyModel::GetCcaBusyCurrentA

(

void

)

const

Definition at line 125 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 182 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 111 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 262 of file wifi-radio-energy-model.cc.

References m_listener, and NS_LOG_FUNCTION.

double ns3::WifiRadioEnergyModel::GetRxCurrentA

(

void

)

const

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

(

void

)

const

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

References m_totalEnergyConsumption, and NS_LOG_FUNCTION.

double ns3::WifiRadioEnergyModel::GetTxCurrentA

(

void

)

const

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

TypeId ns3::WifiRadioEnergyModel::GetTypeId ( void  )

static

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

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

Here is the call graph for this function:

void ns3::WifiRadioEnergyModel::HandleEnergyDepletion ( void  )

virtual

Handles energy depletion.

Implements DeviceEnergyModel::HandleEnergyDepletion

Implements ns3::DeviceEnergyModel.

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

(

double

ccaBusyCurrentA

)

Definition at line 132 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

callback

Callback function.

Sets callback for energy depletion handling.

Definition at line 189 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::SetEnergySource ( 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 96 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 118 of file wifi-radio-energy-model.cc.

References m_idleCurrentA, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::WifiRadioEnergyModel::SetRxCurrentA

(

double

rxCurrentA

)

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

(

double

switchingCurrentA

)

Definition at line 174 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 146 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::SetWifiRadioState ( const WifiPhy::State  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 302 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::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

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

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

WifiPhy::State ns3::WifiRadioEnergyModel::m_currentState

private

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

Referenced by ChangeState(), DoGetCurrentA(), GetCurrentState(), SetWifiRadioState(), and WifiRadioEnergyModel().

WifiRadioEnergyDepletionCallback ns3::WifiRadioEnergyModel::m_energyDepletionCallback

private

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

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

double ns3::WifiRadioEnergyModel::m_idleCurrentA

private

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

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

Time ns3::WifiRadioEnergyModel::m_lastUpdateTime

private

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

Referenced by ChangeState(), and WifiRadioEnergyModel().

WifiRadioEnergyModelPhyListener* ns3::WifiRadioEnergyModel::m_listener

private

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

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

double ns3::WifiRadioEnergyModel::m_rxCurrentA

private

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

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

Ptr<EnergySource> ns3::WifiRadioEnergyModel::m_source

private

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

Referenced by ChangeState(), DoDispose(), SetEnergySource(), and WifiRadioEnergyModel().

double ns3::WifiRadioEnergyModel::m_switchingCurrentA

private

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

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

TracedValue<double> ns3::WifiRadioEnergyModel::m_totalEnergyConsumption

private

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

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

double ns3::WifiRadioEnergyModel::m_txCurrentA

private

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

Referenced by ChangeState(), DoGetCurrentA(), GetTxCurrentA(), and SetTxCurrentA().

---

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

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