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

#include "energy-source-container.h"

Inheritance diagram for ns3::energy::EnergySourceContainer:

Collaboration diagram for ns3::energy::EnergySourceContainer:

Public Types
typedef std::vector< Ptr< EnergySource > >::const_iterator	Iterator
	Const iterator for EnergySource container.

Public Member Functions
	EnergySourceContainer ()
	Creates an empty EnergySourceContainer.

	EnergySourceContainer (const EnergySourceContainer &a, const EnergySourceContainer &b)

	EnergySourceContainer (Ptr< EnergySource > source)

	EnergySourceContainer (std::string sourceName)

	~EnergySourceContainer () override

void	Add (EnergySourceContainer container)

void	Add (Ptr< EnergySource > source)
	Append a single Ptr<EnergySource> to the end of this container.

void	Add (std::string sourceName)
	Append a single Ptr<EnergySource> referred to by its object name to the end of this container.

Iterator	Begin () const
	Get an iterator which refers to the first EnergySource pointer in the container.

Iterator	End () const
	Get an iterator which refers to the last EnergySource pointer in the container.

Ptr< EnergySource >	Get (uint32_t i) const
	Get the i-th Ptr<EnergySource> stored in this container.

uint32_t	GetN () const
	Get the number of Ptr<EnergySource> 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< 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
	Destructor implementation.

void	DoInitialize () override
	Calls Object::Start () for all EnergySource objects.

Private Attributes
std::vector< Ptr< EnergySource > >	m_sources
	Energy source container.

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

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.

Detailed Description

Holds a vector of ns3::EnergySource pointers.

EnergySourceHelper returns a list of EnergySource pointers installed onto a node. Users can use this list to access EnergySource objects to obtain total energy consumption on a node easily.

See also: NetDeviceContainer

Definition at line 36 of file energy-source-container.h.

Member Typedef Documentation

◆ Iterator

typedef std::vector<Ptr<EnergySource>>::const_iterator ns3::energy::EnergySourceContainer::Iterator

Const iterator for EnergySource container.

Definition at line 40 of file energy-source-container.h.

Constructor & Destructor Documentation

◆ EnergySourceContainer() [1/4]

ns3::energy::EnergySourceContainer::EnergySourceContainer ( )

Creates an empty EnergySourceContainer.

Definition at line 33 of file energy-source-container.cc.

◆ ~EnergySourceContainer()

ns3::energy::EnergySourceContainer::~EnergySourceContainer ( )

override

Definition at line 37 of file energy-source-container.cc.

◆ EnergySourceContainer() [2/4]

ns3::energy::EnergySourceContainer::EnergySourceContainer ( Ptr< EnergySource > source )

Parameters

source Pointer to an EnergySource.

Creates an EnergySourceContainer with exactly one EnergySource previously instantiated.

Definition at line 41 of file energy-source-container.cc.

References m_sources, and NS_ASSERT.

◆ EnergySourceContainer() [3/4]

ns3::energy::EnergySourceContainer::EnergySourceContainer ( std::string sourceName )

Parameters

sourceName Name of EnergySource.

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

Definition at line 47 of file energy-source-container.cc.

References ns3::Names::Find(), m_sources, and NS_ASSERT.

Here is the call graph for this function:

◆ EnergySourceContainer() [4/4]

ns3::energy::EnergySourceContainer::EnergySourceContainer	(	const EnergySourceContainer &	a,
		const EnergySourceContainer &	b )

Parameters

a	A EnergySourceContainer.
b	Another EnergySourceContainer.

Creates an EnergySourceContainer by concatenating EnergySourceContainer b to EnergySourceContainer a.

Note: Can be used to concatenate 2 Ptr<EnergySource> directly. C++ will be calling EnergySourceContainer constructor with Ptr<EnergySource> first.

Definition at line 54 of file energy-source-container.cc.

References Add().

Here is the call graph for this function:

Member Function Documentation

◆ Add() [1/3]

void ns3::energy::EnergySourceContainer::Add ( EnergySourceContainer container )

Parameters

container Another EnergySourceContainer to append.

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

Definition at line 86 of file energy-source-container.cc.

References m_sources.

Referenced by EnergySourceContainer(), ns3::GenericBatteryModelHelper::Install(), and UanExperiment::SetupCommunications().

Here is the caller graph for this function:

◆ Add() [2/3]

void ns3::energy::EnergySourceContainer::Add ( Ptr< EnergySource > source )

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

Parameters

source Pointer to an EnergySource.

Definition at line 95 of file energy-source-container.cc.

References m_sources, and NS_ASSERT.

◆ Add() [3/3]

void ns3::energy::EnergySourceContainer::Add ( std::string sourceName )

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

Parameters

sourceName Name of EnergySource object.

Definition at line 102 of file energy-source-container.cc.

References ns3::Names::Find(), m_sources, and NS_ASSERT.

Here is the call graph for this function:

◆ Begin()

EnergySourceContainer::Iterator ns3::energy::EnergySourceContainer::Begin ( ) const

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

Returns: An iterator which refers to the first EnergySource in container.

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

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

Definition at line 62 of file energy-source-container.cc.

References m_sources.

Referenced by ns3::DeviceEnergyModelHelper::Install(), ns3::EnergyHarvesterHelper::Install(), and ns3::GenericBatteryModelHelper::SetCellPack().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::energy::EnergySourceContainer::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 114 of file energy-source-container.cc.

References m_sources.

◆ DoInitialize()

void ns3::energy::EnergySourceContainer::DoInitialize ( )

overrideprivatevirtual

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

Reimplemented from ns3::Object.

Definition at line 126 of file energy-source-container.cc.

References m_sources.

◆ End()

EnergySourceContainer::Iterator ns3::energy::EnergySourceContainer::End ( ) const

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

Returns: An iterator which refers to the last EnergySource in container.

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

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

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

References m_sources.

Referenced by ns3::EnergyHarvesterHelper::Install(), and ns3::GenericBatteryModelHelper::SetCellPack().

Here is the caller graph for this function:

◆ Get()

Ptr< EnergySource > ns3::energy::EnergySourceContainer::Get ( uint32_t i ) const

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

Parameters

i	Index of the requested Ptr<EnergySource>.

Returns: The requested Ptr<EnergySource>.

Definition at line 80 of file energy-source-container.cc.

References m_sources.

Referenced by BatteryLifetimeTest::ConstantLoadTest(), UanExperiment::SetupCommunications(), and BatteryLifetimeTest::VariableLoadTest().

Here is the caller graph for this function:

◆ GetN()

uint32_t ns3::energy::EnergySourceContainer::GetN ( ) const

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

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

Definition at line 74 of file energy-source-container.cc.

References m_sources.

Referenced by ns3::DeviceEnergyModelHelper::Install(), and ns3::GenericBatteryModelHelper::SetCellPack().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::energy::EnergySourceContainer::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

Definition at line 23 of file energy-source-container.cc.

References ns3::TypeId::AddDeprecatedName(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

Member Data Documentation

◆ m_sources

std::vector<Ptr<EnergySource> > ns3::energy::EnergySourceContainer::m_sources

private

Energy source container.

Definition at line 172 of file energy-source-container.h.

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

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

src/energy/helper/energy-source-container.h
src/energy/helper/energy-source-container.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Iterator

Constructor & Destructor Documentation

◆ EnergySourceContainer() [1/4]

◆ ~EnergySourceContainer()

◆ EnergySourceContainer() [2/4]

◆ EnergySourceContainer() [3/4]

◆ EnergySourceContainer() [4/4]

Member Function Documentation

◆ Add() [1/3]

◆ Add() [2/3]

◆ Add() [3/3]

◆ Begin()

◆ DoDispose()

◆ DoInitialize()

◆ End()

◆ Get()

◆ GetN()

◆ GetTypeId()

Member Data Documentation

◆ m_sources