Base class for device energy models. More...

#include <device-energy-model.h>

Inheritance diagram for ns3::DeviceEnergyModel:

Collaboration diagram for ns3::DeviceEnergyModel:

Public Types
typedef Callback< void, int >	ChangeStateCallback
	Callback type for ChangeState function. More...

Public Member Functions
	DeviceEnergyModel ()

virtual	~DeviceEnergyModel ()

virtual void	ChangeState (int newState)=0

double	GetCurrentA (void) const

virtual double	GetTotalEnergyConsumption (void) const =0

virtual void	HandleEnergyDepletion (void)=0
	This function is called by the EnergySource object when energy stored in the energy source is depleted. More...

virtual void	SetEnergySource (Ptr< EnergySource > source)=0

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::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
virtual double	DoGetCurrentA (void) const

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

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

Base class for device energy models.

Doxygen introspection did not find any typical Config paths.

A device energy model should represent the energy consumption behavior of a specific device. It will update remaining energy stored in the EnergySource object installed on node. When energy is depleted, each DeviceEnergyModel object installed on the same node will be informed by the EnergySource.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 43 of file device-energy-model.h.

Member Typedef Documentation

typedef Callback<void, int> ns3::DeviceEnergyModel::ChangeStateCallback

Callback type for ChangeState function.

Devices uses this state to notify DeviceEnergyModel of a state change.

Definition at line 50 of file device-energy-model.h.

Constructor & Destructor Documentation

ns3::DeviceEnergyModel::DeviceEnergyModel ( )

Definition at line 40 of file device-energy-model.cc.

References NS_LOG_FUNCTION.

ns3::DeviceEnergyModel::~DeviceEnergyModel ( )

virtual

Definition at line 45 of file device-energy-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

virtual void ns3::DeviceEnergyModel::ChangeState ( int newState )

pure virtual

Parameters

newState New state the device is in.

DeviceEnergyModel is a state based model. This function is implemented by all child of DeviceEnergyModel to change the model's state. States are to be defined by each child using an enum (int).

Implemented in ns3::WifiRadioEnergyModel, ns3::AcousticModemEnergyModel, and ns3::SimpleDeviceEnergyModel.

Referenced by ns3::AcousticModemEnergyModelHelper::DoInstall(), and ns3::WifiRadioEnergyModel::WifiRadioEnergyModel().

Here is the caller graph for this function:

double ns3::DeviceEnergyModel::DoGetCurrentA ( void ) const

privatevirtual

Returns: 0.0 as the current value, in Ampere.

Child class does not have to implement this method if current draw for its states are not know. This default method will always return 0.0A. For the devices who does know the current draw of its states, this method must be overwritten.

Reimplemented in ns3::WifiRadioEnergyModel, ns3::AcousticModemEnergyModel, and ns3::SimpleDeviceEnergyModel.

Definition at line 62 of file device-energy-model.cc.

References NS_LOG_FUNCTION.

Referenced by GetCurrentA().

Here is the caller graph for this function:

double ns3::DeviceEnergyModel::GetCurrentA ( void ) const

Returns: Current draw of the device, in Ampere.

This function returns the current draw at the device in its current state. This function is called from the EnergySource to obtain the total current draw at any given time during simulation.

Definition at line 51 of file device-energy-model.cc.

References DoGetCurrentA(), and NS_LOG_FUNCTION.

Here is the call graph for this function: