ns-3
ns3::EnergySourceContainer Class Reference

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

#include <energy-source-container.h>

Inheritance diagram for ns3::EnergySourceContainer:
Collaboration diagram for ns3::EnergySourceContainer:

List of all members.

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)
Iterator Begin (void) const
 Get an iterator which refers to the first EnergySource pointer in the container.
Iterator End (void) const
 Get an iterator which refers to the last EnergySource pointer in the container.
uint32_t GetN (void) const
 Get the number of Ptr<EnergySource> stored in this container.
Ptr< EnergySourceGet (uint32_t i) const
 Get the i-th Ptr<EnergySource> stored in this container.
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.

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::Object.

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

Constructor & Destructor Documentation

Parameters:
sourcePointer to an EnergySource.

Creates an EnergySourceContianer with exactly one EnergySource previously instantiated.

References NS_ASSERT.

Parameters:
sourceNameName 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.

References NS_ASSERT.

Parameters:
aA EnergySourceContainer.
bAnother 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.

References Add().


Member Function Documentation

Parameters:
containerAnother EnergySourceContainer to append.

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

References Begin(), and End().

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

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

Parameters:
sourcePointer to an EnergySource.

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:
sourceNameName of EnergySource object.

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
     }

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

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
     }

Referenced by Add().

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

Parameters:
iIndex of the requested Ptr<EnergySource>.
Returns:
The requested Ptr<EnergySource>.
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.

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

This method returns the TypeId associated to ns3::Object.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::AlohaNoackNetDevice/Phy
  • /NodeList/[i]/DeviceList/[i]/$ns3::NonCommunicatingNetDevice/Phy

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

Reimplemented from ns3::Object.

References ns3::TypeId::SetParent().


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