A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::SimpleDeviceEnergyModel Class Reference

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 ()
 
virtual ~SimpleDeviceEnergyModel ()
 
virtual void ChangeState (int newState)
 
virtual Ptr< NodeGetNode (void) const
 Gets pointer to node. More...
 
virtual double GetTotalEnergyConsumption (void) const
 
virtual void HandleEnergyDepletion (void)
 Handles energy depletion. More...
 
void SetCurrentA (double current)
 
virtual void SetEnergySource (Ptr< EnergySource > source)
 Sets pointer to EnergySouce installed on node. More...
 
virtual void SetNode (Ptr< Node > node)
 Sets pointer to node. More...
 
- 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...
 
SimpleRefCountoperator= (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
 

Private Attributes

double m_actualCurrentA
 
Time m_lastUpdateTime
 
Ptr< Nodem_node
 
Ptr< EnergySourcem_source
 
TracedValue< double > m_totalEnergyConsumption
 

Additional Inherited Members

- Public Types inherited from ns3::DeviceEnergyModel
typedef Callback< void, int > ChangeStateCallback
 Callback type for ChangeState function. More...
 
- 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 simple device energy model where current drain can be set by the user.

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

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

Constructor & Destructor Documentation

ns3::SimpleDeviceEnergyModel::SimpleDeviceEnergyModel ( )
ns3::SimpleDeviceEnergyModel::~SimpleDeviceEnergyModel ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

virtual void ns3::SimpleDeviceEnergyModel::ChangeState ( int  newState)
inlinevirtual
Parameters
newStateNew state the device is in.

Not implemented

Implements ns3::DeviceEnergyModel.

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

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

References m_source, and NS_LOG_FUNCTION.

double ns3::SimpleDeviceEnergyModel::DoGetCurrentA ( void  ) const
privatevirtual
Returns
Current draw of device, at current state.

Implements DeviceEnergyModel::GetCurrentA.

Reimplemented from ns3::DeviceEnergyModel.

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

References m_actualCurrentA, and NS_LOG_FUNCTION.

Ptr< Node > ns3::SimpleDeviceEnergyModel::GetNode ( void  ) const
virtual

Gets pointer to node.

Returns
Pointer to node.

Implements DeviceEnergyModel::GetNode.

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

References m_node, and NS_LOG_FUNCTION.

double ns3::SimpleDeviceEnergyModel::GetTotalEnergyConsumption ( void  ) const
virtual
Returns
Total energy consumption of the vehicle.

Implements DeviceEnergyModel::GetTotalEnergyConsumption.

Implements ns3::DeviceEnergyModel.

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

References m_totalEnergyConsumption, and NS_LOG_FUNCTION.

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

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

References m_totalEnergyConsumption, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

virtual void ns3::SimpleDeviceEnergyModel::HandleEnergyDepletion ( void  )
inlinevirtual

Handles energy depletion.

Not implemented

Implements ns3::DeviceEnergyModel.

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

void ns3::SimpleDeviceEnergyModel::SetCurrentA ( double  current)
Parameters
currentthe current draw of device.

Set the actual current draw of the device.

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

References current, ns3::Time::GetSeconds(), m_actualCurrentA, m_lastUpdateTime, m_source, m_totalEnergyConsumption, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by main().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::SimpleDeviceEnergyModel::SetEnergySource ( Ptr< EnergySource source)
virtual

Sets pointer to EnergySouce installed on node.

Parameters
sourcePointer to EnergySource installed on node.

Implements DeviceEnergyModel::SetEnergySource.

Implements ns3::DeviceEnergyModel.

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

References m_source, NS_ASSERT, and NS_LOG_FUNCTION.

void ns3::SimpleDeviceEnergyModel::SetNode ( Ptr< Node node)
virtual

Sets pointer to node.

Parameters
nodePointer to node.

Implements DeviceEnergyModel::SetNode.

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

References m_node, NS_ASSERT, and NS_LOG_FUNCTION.

Member Data Documentation

double ns3::SimpleDeviceEnergyModel::m_actualCurrentA
private
Time ns3::SimpleDeviceEnergyModel::m_lastUpdateTime
private

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

Referenced by SetCurrentA(), and SimpleDeviceEnergyModel().

Ptr<Node> ns3::SimpleDeviceEnergyModel::m_node
private

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

Referenced by GetNode(), and SetNode().

Ptr<EnergySource> ns3::SimpleDeviceEnergyModel::m_source
private
TracedValue<double> ns3::SimpleDeviceEnergyModel::m_totalEnergyConsumption
private

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

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


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