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< EnergySource >	GetEnergySource (void) const

Ptr< Node >	GetNode (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 ()

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

SimpleRefCount &	operator= (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::EnergyHarvester
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	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

Ptr< RandomVariableStream >	m_harvestablePower

TracedValue< double >	m_harvestedPower

Time	m_harvestedPowerUpdateInterval

Time	m_lastHarvestingUpdateTime

TracedValue< double >	m_totalEnergyHarvestedJ

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

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

BasicEnergyHarvester increases remaining energy stored in an associated Energy Source.

Doxygen 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 –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +1000000000.0ns
- 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
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=2.0]
- Flags: construct write read

TraceSources

HarvestedPower: Harvested power by the BasicEnergyHarvester.
TotalEnergyHarvested: Total energy harvested by the harvester.

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

Constructor & Destructor Documentation

ns3::BasicEnergyHarvester::BasicEnergyHarvester ( )

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

References NS_LOG_FUNCTION.

ns3::BasicEnergyHarvester::BasicEnergyHarvester ( Time updateInterval )

Parameters

updateInterval Energy 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 69 of file basic-energy-harvester.cc.

References m_harvestedPowerUpdateInterval, and NS_LOG_FUNCTION.

ns3::BasicEnergyHarvester::~BasicEnergyHarvester ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

int64_t ns3::BasicEnergyHarvester::AssignStreams ( int64_t stream )

Parameters

stream Random 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 81 of file basic-energy-harvester.cc.

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

Here is the call graph for this function:

void ns3::BasicEnergyHarvester::CalculateHarvestedPower ( void )

private

Calculates harvested Power.

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

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

Referenced by UpdateHarvestedPower().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::BasicEnergyHarvester::DoDispose ( void )

privatevirtual

Defined in ns3::Object.

Reimplemented from ns3::EnergyHarvester.

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

References NS_LOG_FUNCTION.

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 174 of file basic-energy-harvester.cc.

References m_harvestedPower, and NS_LOG_FUNCTION.

void ns3::BasicEnergyHarvester::DoInitialize ( void )

privatevirtual

Defined in ns3::Object.

Reimplemented from ns3::Object.

Definition at line 147 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:

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 96 of file basic-energy-harvester.cc.

References m_harvestedPowerUpdateInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::BasicEnergyHarvester::GetTypeId ( void )

static

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

References GetHarvestedPowerUpdateInterval(), m_harvestablePower, m_harvestedPower, m_totalEnergyHarvestedJ, ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::Seconds(), SetHarvestedPowerUpdateInterval(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

void ns3::BasicEnergyHarvester::SetHarvestedPowerUpdateInterval ( Time updateInterval )

Parameters

updateInterval Energy 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 89 of file basic-energy-harvester.cc.

References m_harvestedPowerUpdateInterval, and NS_LOG_FUNCTION.

Referenced by BasicEnergyHarvesterTestCase::DoRun(), and GetTypeId().

Here is the caller graph for this function:

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 107 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, and ns3::Simulator::Schedule().