A simple device energy model where current drain can be set by the user. More...
#include "simple-device-energy-model.h"
Public Member Functions | |
SimpleDeviceEnergyModel () | |
~SimpleDeviceEnergyModel () override | |
void | ChangeState (int newState) override |
virtual Ptr< Node > | GetNode () const |
Gets pointer to node. More... | |
double | GetTotalEnergyConsumption () const override |
void | HandleEnergyChanged () override |
Handles energy changed. More... | |
void | HandleEnergyDepletion () override |
Handles energy depletion. More... | |
void | HandleEnergyRecharged () override |
Handles energy recharged. More... | |
void | SetCurrentA (double current) |
void | SetEnergySource (Ptr< EnergySource > source) override |
Sets pointer to EnergySource installed on node. More... | |
virtual void | SetNode (Ptr< Node > node) |
Sets pointer to node. More... | |
Public Member Functions inherited from ns3::DeviceEnergyModel | |
DeviceEnergyModel () | |
~DeviceEnergyModel () override | |
double | GetCurrentA () const |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () 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< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () 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 () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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 () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::DeviceEnergyModel | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Private Member Functions | |
void | DoDispose () override |
Destructor implementation. More... | |
double | DoGetCurrentA () const override |
Private Attributes | |
double | m_actualCurrentA |
actual curred (in Ampere) More... | |
Time | m_lastUpdateTime |
Last update time. More... | |
Ptr< Node > | m_node |
Node. More... | |
Ptr< EnergySource > | m_source |
Energy source. More... | |
TracedValue< double > | m_totalEnergyConsumption |
Total energy consumption trace. More... | |
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) | |
Copy an Object. More... | |
virtual void | DoInitialize () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
A simple device energy model where current drain can be set by the user.
It is supposed to be used as a testing model for energy sources.
Definition at line 39 of file simple-device-energy-model.h.
ns3::SimpleDeviceEnergyModel::SimpleDeviceEnergyModel | ( | ) |
Definition at line 50 of file simple-device-energy-model.cc.
References m_actualCurrentA, m_lastUpdateTime, m_source, NS_LOG_FUNCTION, and ns3::Seconds().
|
override |
Definition at line 58 of file simple-device-energy-model.cc.
References NS_LOG_FUNCTION.
|
inlineoverridevirtual |
newState | New state the device is in. |
Not implemented
Implements ns3::DeviceEnergyModel.
Definition at line 89 of file simple-device-energy-model.h.
|
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 122 of file simple-device-energy-model.cc.
References m_source, and NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Implements DeviceEnergyModel::GetCurrentA.
Reimplemented from ns3::DeviceEnergyModel.
Definition at line 129 of file simple-device-energy-model.cc.
References m_actualCurrentA, and NS_LOG_FUNCTION.
Gets pointer to node.
Implements DeviceEnergyModel::GetNode.
Definition at line 80 of file simple-device-energy-model.cc.
References m_node, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements DeviceEnergyModel::GetTotalEnergyConsumption.
Implements ns3::DeviceEnergyModel.
Definition at line 87 of file simple-device-energy-model.cc.
References ns3::Time::GetSeconds(), m_actualCurrentA, m_lastUpdateTime, m_source, m_totalEnergyConsumption, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 36 of file simple-device-energy-model.cc.
References m_totalEnergyConsumption, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
|
inlineoverridevirtual |
Handles energy changed.
Not implemented
Implements ns3::DeviceEnergyModel.
Definition at line 116 of file simple-device-energy-model.h.
|
inlineoverridevirtual |
Handles energy depletion.
Not implemented
Implements ns3::DeviceEnergyModel.
Definition at line 98 of file simple-device-energy-model.h.
|
inlineoverridevirtual |
Handles energy recharged.
Not implemented
Implements ns3::DeviceEnergyModel.
Definition at line 107 of file simple-device-energy-model.h.
void ns3::SimpleDeviceEnergyModel::SetCurrentA | ( | double | current | ) |
current | the current draw of device. |
Set the actual current draw of the device.
Definition at line 102 of file simple-device-energy-model.cc.
References ns3::Time::GetSeconds(), m_actualCurrentA, m_lastUpdateTime, m_source, m_totalEnergyConsumption, ns3::Simulator::Now(), and NS_LOG_FUNCTION.
Referenced by LiIonEnergyTestCase::DoRun(), and AnimationRemainingEnergyTestCase::PrepareNetwork().
|
overridevirtual |
Sets pointer to EnergySource installed on node.
source | Pointer to EnergySource installed on node. |
Implements DeviceEnergyModel::SetEnergySource.
Implements ns3::DeviceEnergyModel.
Definition at line 64 of file simple-device-energy-model.cc.
References m_source, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by LiIonEnergyTestCase::DoRun(), and AnimationRemainingEnergyTestCase::PrepareNetwork().
Sets pointer to node.
node | Pointer to node. |
Implements DeviceEnergyModel::SetNode.
Definition at line 72 of file simple-device-energy-model.cc.
References m_node, NS_ASSERT, and NS_LOG_FUNCTION.
|
private |
actual curred (in Ampere)
Definition at line 138 of file simple-device-energy-model.h.
Referenced by SimpleDeviceEnergyModel(), DoGetCurrentA(), GetTotalEnergyConsumption(), and SetCurrentA().
|
private |
Last update time.
Definition at line 137 of file simple-device-energy-model.h.
Referenced by SimpleDeviceEnergyModel(), GetTotalEnergyConsumption(), and SetCurrentA().
Node.
Definition at line 140 of file simple-device-energy-model.h.
|
private |
Energy source.
Definition at line 139 of file simple-device-energy-model.h.
Referenced by SimpleDeviceEnergyModel(), DoDispose(), GetTotalEnergyConsumption(), SetCurrentA(), and SetEnergySource().
|
private |
Total energy consumption trace.
Definition at line 141 of file simple-device-energy-model.h.
Referenced by GetTotalEnergyConsumption(), GetTypeId(), and SetCurrentA().