A Discrete-Event Network Simulator
API
ns3::BasicEnergyHarvester Class Reference

BasicEnergyHarvester increases remaining energy stored in an associated Energy Source. More...

#include "basic-energy-harvester.h"

+ Inheritance diagram for ns3::BasicEnergyHarvester:
+ Collaboration diagram for ns3::BasicEnergyHarvester:

Public Member Functions

 BasicEnergyHarvester ()
 
 BasicEnergyHarvester (Time updateInterval)
 
virtual ~BasicEnergyHarvester ()
 
int64_t AssignStreams (int64_t stream)
 
Time GetHarvestedPowerUpdateInterval (void) const
 
void SetHarvestedPowerUpdateInterval (Time updateInterval)
 
- Public Member Functions inherited from ns3::EnergyHarvester
 EnergyHarvester ()
 
virtual ~EnergyHarvester ()
 
Ptr< EnergySourceGetEnergySource (void) const
 
Ptr< NodeGetNode (void) const
 
double GetPower (void) const
 
void SetEnergySource (Ptr< EnergySource > source)
 
void SetNode (Ptr< Node > node)
 Sets pointer to node containing this EnergyHarvester. More...
 
- 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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::EnergyHarvester
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

void CalculateHarvestedPower (void)
 Calculates harvested Power. More...
 
void DoDispose (void)
 Defined in ns3::Object. More...
 
virtual double DoGetPower (void) const
 
void DoInitialize (void)
 Defined in ns3::Object. More...
 
void UpdateHarvestedPower (void)
 This function is called every m_energyHarvestingUpdateInterval in order to update the amount of power that will be provided by the harvester in the next interval. More...
 

Private Attributes

EventId m_energyHarvestingUpdateEvent
 energy harvesting event More...
 
Ptr< RandomVariableStreamm_harvestablePower
 Random variable for the harvestable power. More...
 
TracedValue< doublem_harvestedPower
 current harvested power, in Watt More...
 
Time m_harvestedPowerUpdateInterval
 harvestable energy update interval More...
 
Time m_lastHarvestingUpdateTime
 last harvesting time More...
 
TracedValue< doublem_totalEnergyHarvestedJ
 total harvested energy, in Joule More...
 

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

BasicEnergyHarvester increases remaining energy stored in an associated Energy Source.

Introspection did not find any typical Config paths.

The BasicEnergyHarvester implements a simple model in which the amount of power provided by the harvester varies over time according to a customizable generic random variable and time update intervals.

Unit of power is chosen as Watt since energy models typically calculate energy as (time in seconds * power in Watt).


Attributes

  • PeriodicHarvestedPowerUpdateInterval: Time between two consecutive periodic updates of the harvested power. By default, the value is updated every 1 s
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +1e+09ns
    • Flags: construct write read
  • HarvestablePower: The harvestable power [Watts] that the energy harvester is allowed to harvest. By default, the model will allow to harvest an amount of power defined by a uniformly distributed random variable in 0 and 2.0 Watts

TraceSources

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

Definition at line 48 of file basic-energy-harvester.h.

Constructor & Destructor Documentation

◆ BasicEnergyHarvester() [1/2]

ns3::BasicEnergyHarvester::BasicEnergyHarvester ( )

Definition at line 67 of file basic-energy-harvester.cc.

References NS_LOG_FUNCTION.

◆ BasicEnergyHarvester() [2/2]

ns3::BasicEnergyHarvester::BasicEnergyHarvester ( Time  updateInterval)
Parameters
updateIntervalEnergy harvesting update interval.

BasicEnergyHarvester constructor function that sets the interval between each update of the value of the power harvested by this energy harvester.

Definition at line 72 of file basic-energy-harvester.cc.

References m_harvestedPowerUpdateInterval, and NS_LOG_FUNCTION.

◆ ~BasicEnergyHarvester()

ns3::BasicEnergyHarvester::~BasicEnergyHarvester ( )
virtual

Definition at line 78 of file basic-energy-harvester.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::BasicEnergyHarvester::AssignStreams ( int64_t  stream)
Parameters
streamRandom variable stream number.
Returns
The number of stream indices assigned by this model.

This function sets the stream number to be used by the random variable that determines the amount of power that can be harvested by this energy harvester.

Definition at line 84 of file basic-energy-harvester.cc.

References m_harvestablePower, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ CalculateHarvestedPower()

void ns3::BasicEnergyHarvester::CalculateHarvestedPower ( void  )
private

Calculates harvested Power.

Definition at line 166 of file basic-energy-harvester.cc.

References ns3::RandomVariableStream::GetValue(), m_harvestablePower, m_harvestedPower, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Time::S.

Referenced by UpdateHarvestedPower().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::BasicEnergyHarvester::DoDispose ( void  )
privatevirtual

Defined in ns3::Object.

Reimplemented from ns3::EnergyHarvester.

Definition at line 160 of file basic-energy-harvester.cc.

References NS_LOG_FUNCTION.

◆ DoGetPower()

double ns3::BasicEnergyHarvester::DoGetPower ( void  ) const
privatevirtual
Returns
m_harvestedPower The power currently provided by the Basic Energy Harvester. Implements DoGetPower defined in EnergyHarvester.

Reimplemented from ns3::EnergyHarvester.

Definition at line 177 of file basic-energy-harvester.cc.

References m_harvestedPower, and NS_LOG_FUNCTION.

◆ DoInitialize()

void ns3::BasicEnergyHarvester::DoInitialize ( void  )
privatevirtual

Defined in ns3::Object.

Reimplemented from ns3::Object.

Definition at line 150 of file basic-energy-harvester.cc.

References m_lastHarvestingUpdateTime, ns3::Simulator::Now(), NS_LOG_FUNCTION, and UpdateHarvestedPower().

+ Here is the call graph for this function:

◆ GetHarvestedPowerUpdateInterval()

Time ns3::BasicEnergyHarvester::GetHarvestedPowerUpdateInterval ( void  ) const
Returns
The interval between each update of the harvested power.

This function returns the interval between each update of the value of the power harvested by this energy harvester.

Definition at line 99 of file basic-energy-harvester.cc.

References m_harvestedPowerUpdateInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetTypeId()

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

◆ SetHarvestedPowerUpdateInterval()

void ns3::BasicEnergyHarvester::SetHarvestedPowerUpdateInterval ( Time  updateInterval)
Parameters
updateIntervalEnergy harvesting update interval.

This function sets the interval between each update of the value of the power harvested by this energy harvester.

Definition at line 92 of file basic-energy-harvester.cc.

References m_harvestedPowerUpdateInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ UpdateHarvestedPower()

void ns3::BasicEnergyHarvester::UpdateHarvestedPower ( void  )
private

This function is called every m_energyHarvestingUpdateInterval in order to update the amount of power that will be provided by the harvester in the next interval.

Definition at line 110 of file basic-energy-harvester.cc.

References CalculateHarvestedPower(), ns3::EventId::Cancel(), ns3::EnergyHarvester::GetEnergySource(), ns3::Time::GetNanoSeconds(), ns3::EnergyHarvester::GetNode(), ns3::Time::GetSeconds(), ns3::Simulator::IsFinished(), m_energyHarvestingUpdateEvent, m_harvestedPower, m_harvestedPowerUpdateInterval, m_lastHarvestingUpdateTime, m_totalEnergyHarvestedJ, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Time::S, ns3::Simulator::Schedule(), and UpdateHarvestedPower().

Referenced by DoInitialize(), and UpdateHarvestedPower().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_energyHarvestingUpdateEvent

EventId ns3::BasicEnergyHarvester::m_energyHarvestingUpdateEvent
private

energy harvesting event

Definition at line 127 of file basic-energy-harvester.h.

Referenced by UpdateHarvestedPower().

◆ m_harvestablePower

Ptr<RandomVariableStream> ns3::BasicEnergyHarvester::m_harvestablePower
private

Random variable for the harvestable power.

Definition at line 122 of file basic-energy-harvester.h.

Referenced by AssignStreams(), CalculateHarvestedPower(), and GetTypeId().

◆ m_harvestedPower

TracedValue<double> ns3::BasicEnergyHarvester::m_harvestedPower
private

current harvested power, in Watt

Definition at line 124 of file basic-energy-harvester.h.

Referenced by CalculateHarvestedPower(), DoGetPower(), GetTypeId(), and UpdateHarvestedPower().

◆ m_harvestedPowerUpdateInterval

Time ns3::BasicEnergyHarvester::m_harvestedPowerUpdateInterval
private

harvestable energy update interval

Definition at line 129 of file basic-energy-harvester.h.

Referenced by BasicEnergyHarvester(), GetHarvestedPowerUpdateInterval(), SetHarvestedPowerUpdateInterval(), and UpdateHarvestedPower().

◆ m_lastHarvestingUpdateTime

Time ns3::BasicEnergyHarvester::m_lastHarvestingUpdateTime
private

last harvesting time

Definition at line 128 of file basic-energy-harvester.h.

Referenced by DoInitialize(), and UpdateHarvestedPower().

◆ m_totalEnergyHarvestedJ

TracedValue<double> ns3::BasicEnergyHarvester::m_totalEnergyHarvestedJ
private

total harvested energy, in Joule

Definition at line 125 of file basic-energy-harvester.h.

Referenced by GetTypeId(), and UpdateHarvestedPower().


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