A Discrete-Event Network Simulator
API
ns3::DeviceEnergyModel Class Referenceabstract

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 HandleEnergyChanged (void)=0
 This function is called by the EnergySource object when energy stored in the energy source is changed. More...
 
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 HandleEnergyRecharged (void)=0
 This function is called by the EnergySource object when energy stored in the energy source is recharged. More...
 
virtual void SetEnergySource (Ptr< EnergySource > source)=0
 
- 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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::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

virtual double DoGetCurrentA (void) const
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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...
 

Detailed Description

Base class for device energy models.

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.
Size of this type is 32 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ 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

◆ DeviceEnergyModel()

ns3::DeviceEnergyModel::DeviceEnergyModel ( )

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

References NS_LOG_FUNCTION.

◆ ~DeviceEnergyModel()

ns3::DeviceEnergyModel::~DeviceEnergyModel ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ChangeState()

virtual void ns3::DeviceEnergyModel::ChangeState ( int  newState)
pure virtual
Parameters
newStateNew 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::WifiRadioEnergyModel::WifiRadioEnergyModel(), and ns3::AcousticModemEnergyModelHelper::DoInstall().

+ Here is the caller graph for this function:

◆ DoGetCurrentA()

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:

◆ GetCurrentA()

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:

◆ GetTotalEnergyConsumption()

virtual double ns3::DeviceEnergyModel::GetTotalEnergyConsumption ( void  ) const
pure virtual
Returns
Total energy consumption of the device.

DeviceEnergyModel records its own energy consumption during simulation.

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

◆ GetTypeId()

TypeId ns3::DeviceEnergyModel::GetTypeId ( void  )
static

Get the type ID.

Returns
The object TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ HandleEnergyChanged()

virtual void ns3::DeviceEnergyModel::HandleEnergyChanged ( void  )
pure virtual

This function is called by the EnergySource object when energy stored in the energy source is changed.

Should be implemented by child classes.

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

◆ HandleEnergyDepletion()

virtual void ns3::DeviceEnergyModel::HandleEnergyDepletion ( void  )
pure virtual

This function is called by the EnergySource object when energy stored in the energy source is depleted.

Should be implemented by child classes.

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

◆ HandleEnergyRecharged()

virtual void ns3::DeviceEnergyModel::HandleEnergyRecharged ( void  )
pure virtual

This function is called by the EnergySource object when energy stored in the energy source is recharged.

Should be implemented by child classes.

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

◆ SetEnergySource()

virtual void ns3::DeviceEnergyModel::SetEnergySource ( Ptr< EnergySource source)
pure virtual
Parameters
sourcePointer to energy source installed on node.

This function sets the pointer to energy source installed on node. Should be called only by DeviceEnergyModel helper classes.

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


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