Energy harvester base class. More...
#include "energy-harvester.h"
Public Member Functions | |
EnergyHarvester () | |
~EnergyHarvester () override | |
Ptr< EnergySource > | GetEnergySource () const |
Ptr< Node > | GetNode () const |
double | GetPower () const |
void | SetEnergySource (Ptr< EnergySource > source) |
void | SetNode (Ptr< Node > node) |
Sets pointer to node containing this EnergyHarvester. | |
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. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
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, bool permissive=false) 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. | |
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::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 |
Defined in ns3::Object. | |
virtual double | DoGetPower () const |
This method is called by the GetPower method and it needs to be implemented by the subclasses of the energy harvester. | |
Private Attributes | |
Ptr< EnergySource > | m_energySource |
Pointer to the Energy Source to which this EnergyHarvester is connected. | |
Ptr< Node > | m_node |
Pointer to node containing this EnergyHarvester. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
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 Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Energy harvester base class.
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Energy
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 35 of file energy-harvester.h.
ns3::energy::EnergyHarvester::EnergyHarvester | ( | ) |
Definition at line 32 of file energy-harvester.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 37 of file energy-harvester.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Defined in ns3::Object.
Reimplemented from ns3::Object.
Definition at line 84 of file energy-harvester.cc.
References NS_LOG_FUNCTION.
|
privatevirtual |
This method is called by the GetPower method and it needs to be implemented by the subclasses of the energy harvester.
It returns the actual amount of power that is currently provided by the energy harvester.
This method should be used to connect the logic behind the particular implementation of the energy harvester with the energy source.
Reimplemented in ns3::energy::BasicEnergyHarvester.
Definition at line 90 of file energy-harvester.cc.
References NS_LOG_FUNCTION.
Referenced by GetPower().
Ptr< EnergySource > ns3::energy::EnergyHarvester::GetEnergySource | ( | ) | const |
When a subclass needs to get access to the connected energy source, it can invoke this method.
Definition at line 66 of file energy-harvester.cc.
References m_energySource, and NS_LOG_FUNCTION.
Referenced by ns3::energy::BasicEnergyHarvester::UpdateHarvestedPower().
When a subclass needs to get access to the underlying node base class to print the nodeId for example, it can invoke this method.
Definition at line 51 of file energy-harvester.cc.
References m_node, and NS_LOG_FUNCTION.
Referenced by ns3::energy::BasicEnergyHarvester::UpdateHarvestedPower().
double ns3::energy::EnergyHarvester::GetPower | ( | ) | const |
This method is called by the energy source connected to the harvester in order to determine the amount of energy that the harvester provided since last update.
Definition at line 73 of file energy-harvester.cc.
References DoGetPower(), and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 23 of file energy-harvester.cc.
References ns3::TypeId::AddDeprecatedName(), and ns3::TypeId::SetParent().
void ns3::energy::EnergyHarvester::SetEnergySource | ( | Ptr< EnergySource > | source | ) |
source | Pointer to energy source to which this EnergyHarvester is installed. |
This function sets the pointer to the energy source connected to the energy harvester.
Definition at line 58 of file energy-harvester.cc.
References m_energySource, NS_ASSERT, and NS_LOG_FUNCTION.
Sets pointer to node containing this EnergyHarvester.
node | Pointer to node containing this EnergyHarvester. |
Definition at line 43 of file energy-harvester.cc.
References m_node, NS_ASSERT, and NS_LOG_FUNCTION.
|
private |
Pointer to the Energy Source to which this EnergyHarvester is connected.
Used by helper class to make sure energy harvesters are installed onto the corresponding energy source.
Definition at line 119 of file energy-harvester.h.
Referenced by GetEnergySource(), and SetEnergySource().
Pointer to node containing this EnergyHarvester.
Used by helper class to make sure energy harvesters are installed onto the corresponding node.
Definition at line 112 of file energy-harvester.h.