Energy harvester base class. More...

#include <energy-harvester.h>

Inheritance diagram for ns3::EnergyHarvester:

Collaboration diagram for ns3::EnergyHarvester:

Public Member Functions
	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::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
virtual void	DoDispose (void)
	Defined in ns3::Object. More...

virtual double	DoGetPower (void) const
	This method is called by the GetPower method and it needs to be implemented by the subclasses of the energy harvester. More...

Private Attributes
Ptr< EnergySource >	m_energySource
	Pointer to the Energy Source to which this EnergyHarvester is connected. More...

Ptr< Node >	m_node
	Pointer to node containing this EnergyHarvester. More...

Additional Inherited Members
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

Energy harvester base class.

Doxygen introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 51 of file energy-harvester.h.

Constructor & Destructor Documentation

ns3::EnergyHarvester::EnergyHarvester ( )

Definition at line 40 of file energy-harvester.cc.

References NS_LOG_FUNCTION.

ns3::EnergyHarvester::~EnergyHarvester ( )

virtual

Definition at line 45 of file energy-harvester.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::EnergyHarvester::DoDispose ( void )

privatevirtual

Defined in ns3::Object.

Reimplemented from ns3::Object.

Reimplemented in ns3::BasicEnergyHarvester.

Definition at line 93 of file energy-harvester.cc.

References NS_LOG_FUNCTION.

double ns3::EnergyHarvester::DoGetPower ( void ) const

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

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

References NS_LOG_FUNCTION.

Referenced by GetPower().

Here is the caller graph for this function:

Ptr< EnergySource > ns3::EnergyHarvester::GetEnergySource ( void ) const

Returns: source Pointer to energy source connected to the harvester.

When a subclass needs to get access to the connected energy source, it can invoke this method.

Definition at line 74 of file energy-harvester.cc.

References m_energySource, and NS_LOG_FUNCTION.

Referenced by ns3::BasicEnergyHarvester::UpdateHarvestedPower().

Here is the caller graph for this function:

Ptr< Node > ns3::EnergyHarvester::GetNode ( void ) const

Returns: Pointer to node containing this EnergyHarvester.

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

References m_node, and NS_LOG_FUNCTION.

Referenced by ns3::BasicEnergyHarvester::UpdateHarvestedPower().

Here is the caller graph for this function:

double ns3::EnergyHarvester::GetPower ( void ) const

Returns: power Amount of power currently provided by the harvester.

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

References DoGetPower(), and NS_LOG_FUNCTION.

Referenced by BasicEnergyHarvesterTestCase::DoRun().

Here is the call graph for this function: