A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::EnergyHarvesterContainer Class Reference

Holds a vector of ns3::EnergyHarvester pointers. More...

#include "energy-harvester-container.h"

+ Inheritance diagram for ns3::EnergyHarvesterContainer:
+ Collaboration diagram for ns3::EnergyHarvesterContainer:

Public Types

typedef std::vector< Ptr< EnergyHarvester > >::const_iterator Iterator
 Const iterator for EnergyHarvester container.
 

Public Member Functions

 EnergyHarvesterContainer ()
 Creates an empty EnergyHarvesterContainer.
 
 EnergyHarvesterContainer (const EnergyHarvesterContainer &a, const EnergyHarvesterContainer &b)
 
 EnergyHarvesterContainer (Ptr< EnergyHarvester > harvester)
 
 EnergyHarvesterContainer (std::string harvesterName)
 
 ~EnergyHarvesterContainer () override
 
void Add (EnergyHarvesterContainer container)
 
void Add (Ptr< EnergyHarvester > harvester)
 Append a single Ptr<EnergyHarvester> to the end of this container.
 
void Add (std::string harvesterName)
 Append a single Ptr<EnergyHarvester> referred to by its object name to the end of this container.
 
Iterator Begin () const
 Get an iterator which refers to the first EnergyHarvester pointer in the container.
 
void Clear ()
 Removes all elements in the container.
 
Iterator End () const
 Get an iterator which refers to the last EnergyHarvester pointer in the container.
 
Ptr< EnergyHarvesterGet (uint32_t i) const
 Get the i-th Ptr<EnergyHarvester> stored in this container.
 
uint32_t GetN () const
 Get the number of Ptr<EnergyHarvester> stored in this container.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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) 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.
 
virtual TypeId GetInstanceTypeId () const =0
 Get the most derived TypeId for this Object.
 
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
 Destructor implementation.
 
void DoInitialize () override
 Calls Object::Initialize () for all EnergySource objects.
 

Private Attributes

std::vector< Ptr< EnergyHarvester > > m_harvesters
 Harvester container.
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoDispose ()
 Destructor implementation.
 
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.
 

Detailed Description

Holds a vector of ns3::EnergyHarvester pointers.

EnergyHarvesterContainer returns a list of EnergyHarvester pointers installed on a node. Users can use this list to access EnergyHarvester objects to obtain the total energy harvested on a node easily.

See also
NetDeviceContainer

Config Paths

ns3::EnergyHarvesterContainer is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/$ns3::EnergyHarvesterContainer"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 46 of file energy-harvester-container.h.

Member Typedef Documentation

◆ Iterator

typedef std::vector<Ptr<EnergyHarvester>>::const_iterator ns3::EnergyHarvesterContainer::Iterator

Const iterator for EnergyHarvester container.

Definition at line 50 of file energy-harvester-container.h.

Constructor & Destructor Documentation

◆ EnergyHarvesterContainer() [1/4]

ns3::EnergyHarvesterContainer::EnergyHarvesterContainer ( )

Creates an empty EnergyHarvesterContainer.

Definition at line 43 of file energy-harvester-container.cc.

References NS_LOG_FUNCTION.

◆ ~EnergyHarvesterContainer()

ns3::EnergyHarvesterContainer::~EnergyHarvesterContainer ( )
override

Definition at line 48 of file energy-harvester-container.cc.

References NS_LOG_FUNCTION.

◆ EnergyHarvesterContainer() [2/4]

ns3::EnergyHarvesterContainer::EnergyHarvesterContainer ( Ptr< EnergyHarvester harvester)
Parameters
harvesterPointer to an EnergyHarvester.

Creates a EnergyHarvesterContainer with exactly one EnergyHarvester previously instantiated.

Definition at line 53 of file energy-harvester-container.cc.

References m_harvesters, NS_ASSERT, and NS_LOG_FUNCTION.

◆ EnergyHarvesterContainer() [3/4]

ns3::EnergyHarvesterContainer::EnergyHarvesterContainer ( std::string  harvesterName)
Parameters
harvesterNameName of EnergyHarvester.

Creates an EnergyHarvesterContainer with exactly one EnergyHarvester previously instantiated and assigned a name using the Object name service. This EnergyHarvester is specified by its assigned name.

Definition at line 60 of file energy-harvester-container.cc.

References m_harvesters, NS_ASSERT, and NS_LOG_FUNCTION.

◆ EnergyHarvesterContainer() [4/4]

ns3::EnergyHarvesterContainer::EnergyHarvesterContainer ( const EnergyHarvesterContainer a,
const EnergyHarvesterContainer b 
)
Parameters
aA EnergyHarvesterContainer.
bAnother EnergyHarvesterContainer.

Creates a EnergyHarvesterContainer by concatenating EnergyHarvesterContainer b to EnergyHarvesterContainer a.

Note
Can be used to concatenate 2 Ptr<EnergyHarvester> directly. C++ will be calling EnergyHarvesterContainer constructor with Ptr<EnergyHarvester> first.

Definition at line 68 of file energy-harvester-container.cc.

References Add(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Function Documentation

◆ Add() [1/3]

void ns3::EnergyHarvesterContainer::Add ( EnergyHarvesterContainer  container)
Parameters
containerAnother EnergyHarvesterContainer.

Appends the contents of another EnergyHarvesterContainer to the end of this EnergyHarvesterContainer.

Definition at line 105 of file energy-harvester-container.cc.

References m_harvesters, and NS_LOG_FUNCTION.

Referenced by EnergyHarvesterContainer().

+ Here is the caller graph for this function:

◆ Add() [2/3]

void ns3::EnergyHarvesterContainer::Add ( Ptr< EnergyHarvester harvester)

Append a single Ptr<EnergyHarvester> to the end of this container.

Parameters
harvesterPointer to an EnergyHarvester.

Definition at line 115 of file energy-harvester-container.cc.

References m_harvesters, NS_ASSERT, and NS_LOG_FUNCTION.

◆ Add() [3/3]

void ns3::EnergyHarvesterContainer::Add ( std::string  harvesterName)

Append a single Ptr<EnergyHarvester> referred to by its object name to the end of this container.

Parameters
harvesterNameName of EnergyHarvester object.

Definition at line 123 of file energy-harvester-container.cc.

References m_harvesters, NS_ASSERT, and NS_LOG_FUNCTION.

◆ Begin()

EnergyHarvesterContainer::Iterator ns3::EnergyHarvesterContainer::Begin ( ) const

Get an iterator which refers to the first EnergyHarvester pointer in the container.

Returns
An iterator which refers to the first EnergyHarvester in container.

EnergyHarvesters can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the iterator method and is typically used in a for-loop to run through the EnergyHarvesters.

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some EnergyHarvester method
}
std::vector< Ptr< EnergyHarvester > >::const_iterator Iterator
Const iterator for EnergyHarvester container.

Definition at line 77 of file energy-harvester-container.cc.

References m_harvesters, and NS_LOG_FUNCTION.

◆ Clear()

void ns3::EnergyHarvesterContainer::Clear ( )

Removes all elements in the container.

Definition at line 132 of file energy-harvester-container.cc.

References m_harvesters, and NS_LOG_FUNCTION.

◆ DoDispose()

void ns3::EnergyHarvesterContainer::DoDispose ( )
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 143 of file energy-harvester-container.cc.

References m_harvesters.

◆ DoInitialize()

void ns3::EnergyHarvesterContainer::DoInitialize ( )
overrideprivatevirtual

Calls Object::Initialize () for all EnergySource objects.

Reimplemented from ns3::Object.

Definition at line 154 of file energy-harvester-container.cc.

References m_harvesters.

◆ End()

EnergyHarvesterContainer::Iterator ns3::EnergyHarvesterContainer::End ( ) const

Get an iterator which refers to the last EnergyHarvester pointer in the container.

Returns
An iterator which refers to the last EnergyHarvester in container.

EnergyHarvesters can be retrieved from the container in two ways. First, directly by an index into the container, and second, using an iterator. This method is used in the iterator method and is typically used in a for-loop to run through the EnergyHarvesters.

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some EnergyHarvester method
}

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

References m_harvesters, and NS_LOG_FUNCTION.

◆ Get()

Ptr< EnergyHarvester > ns3::EnergyHarvesterContainer::Get ( uint32_t  i) const

Get the i-th Ptr<EnergyHarvester> stored in this container.

Parameters
iIndex of the requested Ptr<EnergyHarvester>.
Returns
The requested Ptr<EnergyHarvester>.

Definition at line 98 of file energy-harvester-container.cc.

References m_harvesters, and NS_LOG_FUNCTION.

◆ GetN()

uint32_t ns3::EnergyHarvesterContainer::GetN ( ) const

Get the number of Ptr<EnergyHarvester> stored in this container.

Returns
The number of Ptr<EnergyHarvester> stored in this container.

Definition at line 91 of file energy-harvester-container.cc.

References m_harvesters, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::EnergyHarvesterContainer::GetTypeId ( )
static

Get the type ID.

Returns
The object TypeId.

Definition at line 34 of file energy-harvester-container.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_harvesters

std::vector<Ptr<EnergyHarvester> > ns3::EnergyHarvesterContainer::m_harvesters
private

Harvester container.

Definition at line 188 of file energy-harvester-container.h.

Referenced by EnergyHarvesterContainer(), Add(), Begin(), Clear(), DoDispose(), DoInitialize(), End(), Get(), and GetN().


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