A simple device energy model where current drain can be set by the user. More...

#include "simple-device-energy-model.h"

Inheritance diagram for ns3::SimpleDeviceEnergyModel:

Collaboration diagram for ns3::SimpleDeviceEnergyModel:

Public Member Functions
	SimpleDeviceEnergyModel ()

	~SimpleDeviceEnergyModel () override

void	ChangeState (int newState) override

virtual Ptr< Node >	GetNode () const
	Gets pointer to node.

double	GetTotalEnergyConsumption () const override

void	HandleEnergyChanged () override
	Handles energy changed.

void	HandleEnergyDepletion () override
	Handles energy depletion.

void	HandleEnergyRecharged () override
	Handles energy recharged.

void	SetCurrentA (double current)

void	SetEnergySource (Ptr< EnergySource > source) override
	Sets pointer to EnergySource installed on node.

virtual void	SetNode (Ptr< Node > node)
	Sets pointer to node.

Public Member Functions inherited from ns3::DeviceEnergyModel
	DeviceEnergyModel ()

	~DeviceEnergyModel () override

virtual void	ChangeState (int newState)=0

double	GetCurrentA () const

virtual double	GetTotalEnergyConsumption () const =0

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

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

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

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

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< Object >	GetObject () 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< Object >	GetObject (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.

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.

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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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

double	DoGetCurrentA () const override

Private Attributes
double	m_actualCurrentA
	actual curred (in Ampere)

Time	m_lastUpdateTime
	Last update time.

Ptr< Node >	m_node
	Node.

Ptr< EnergySource >	m_source
	Energy source.

TracedValue< double >	m_totalEnergyConsumption
	Total energy consumption trace.

Additional Inherited Members
Public Types inherited from ns3::DeviceEnergyModel
typedef Callback< void, int >	ChangeStateCallback
	Callback type for ChangeState function.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

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.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

A simple device energy model where current drain can be set by the user.

Introspection did not find any typical Config paths.

It is supposed to be used as a testing model for energy sources.

No Attributes are defined for this type.

TraceSources

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

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

Definition at line 38 of file simple-device-energy-model.h.

Constructor & Destructor Documentation

◆ SimpleDeviceEnergyModel()

ns3::SimpleDeviceEnergyModel::SimpleDeviceEnergyModel ( )

Definition at line 49 of file simple-device-energy-model.cc.

References m_actualCurrentA, m_lastUpdateTime, m_source, NS_LOG_FUNCTION, and ns3::Seconds().

Here is the call graph for this function:

◆ ~SimpleDeviceEnergyModel()

ns3::SimpleDeviceEnergyModel::~SimpleDeviceEnergyModel ( )

override

Definition at line 57 of file simple-device-energy-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ChangeState()

void ns3::SimpleDeviceEnergyModel::ChangeState ( int newState )

inlineoverridevirtual

Parameters

newState New state the device is in.

Not implemented

Implements ns3::DeviceEnergyModel.

Definition at line 88 of file simple-device-energy-model.h.

◆ DoDispose()

void ns3::SimpleDeviceEnergyModel::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 121 of file simple-device-energy-model.cc.

References m_source, and NS_LOG_FUNCTION.