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
Public Types inherited from ns3::DeviceEnergyModel
typedef Callback< void, int >	ChangeStateCallback

Public Member Functions
	WifiRadioEnergyModel ()
virtual	~WifiRadioEnergyModel ()
virtual void	ChangeState (int newState)
	Changes state of the WifiRadioEnergyMode.
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.
void	SetCcaBusyCurrentA (double ccaBusyCurrentA)
void	SetEnergyDepletionCallback (WifiRadioEnergyDepletionCallback callback)
virtual void	SetEnergySource (Ptr< EnergySource > source)
	Sets pointer to EnergySouce installed on node.
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)
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)
	This method returns the TypeId associated to ns3::WifiRadioEnergyModel.

Private Member Functions
void	DoDispose (void)
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	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

A WiFi radio energy model.

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

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::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(), ns3::Seconds(), 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.

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

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

Here is the call graph for this function:

void ns3::WifiRadioEnergyModel::DoDispose ( void )

private

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

References m_energyDepletionCallback, m_source, 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.

Definition at line 270 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, ns3::WifiPhy::RX, ns3::WifiPhy::SWITCHING, and ns3::WifiPhy::TX.

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

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

References m_ccaBusyCurrentA.

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

References m_currentState.

Referenced by BasicEnergyUpdateTest::StateSwitchTest().

Here is the caller graph for this function:

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

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

References m_idleCurrentA.

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

References m_listener.

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

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

References m_rxCurrentA.

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

Here is the caller graph for this function:

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

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

References m_switchingCurrentA.

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

References m_totalEnergyConsumption.

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

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

References m_txCurrentA.

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

Here is the caller graph for this function:

TypeId ns3::WifiRadioEnergyModel::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::WifiRadioEnergyModel.

Attributes defined for this type:

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