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

#include <energy-source-container.h>

Inheritance diagram for ns3::EnergySourceContainer:

Public Types
typedef std::vector< Ptr < EnergySource > >::const_iterator	Iterator

Public Member Functions
	EnergySourceContainer ()

	EnergySourceContainer (Ptr< EnergySource > source)

	EnergySourceContainer (std::string sourceName)

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

void	Add (EnergySourceContainer container)

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

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

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

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

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

uint32_t	GetN (void) const
	Get the number of Ptr<EnergySource> stored in this container. More...

Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

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)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
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)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Member Functions
virtual void	DoDispose (void)

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

Private Attributes
std::vector< Ptr< EnergySource > >	m_sources

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

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

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 44 of file energy-source-container.h.

Constructor & Destructor Documentation

ns3::EnergySourceContainer::EnergySourceContainer ( )

Creates an empty EnergySourceContainer.

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

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

Parameters

source Pointer to an EnergySource.

Creates an EnergySourceContianer with exactly one EnergySource previously instantiated.

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

References NS_ASSERT.

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

References NS_ASSERT.

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

References Add().

Member Function Documentation

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

References Begin(), and End().

Referenced by EnergySourceContainer(), and ns3::EnergySourceHelper::Install().

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

References NS_ASSERT.

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

References NS_ASSERT.

EnergySourceContainer::Iterator ns3::EnergySourceContainer::Begin ( void ) 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 67 of file energy-source-container.cc.

Referenced by Add(), and ns3::DeviceEnergyModelHelper::Install().

void ns3::EnergySourceContainer::DoDispose ( void )

privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 119 of file energy-source-container.cc.

EnergySourceContainer::Iterator ns3::EnergySourceContainer::End ( void ) 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 73 of file energy-source-container.cc.

Referenced by Add().

Ptr< EnergySource > ns3::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 85 of file energy-source-container.cc.

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

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

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

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

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

Referenced by ns3::DeviceEnergyModelHelper::Install().

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

Constructor & Destructor Documentation

Member Function Documentation