Holds a vector of ns3::EnergySource pointers. More...
#include <energy-source-container.h>
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< EnergySource > | Get (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. |
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.
ns3::EnergySourceContainer::EnergySourceContainer | ( | ) |
Creates an empty EnergySourceContainer.
ns3::EnergySourceContainer::EnergySourceContainer | ( | Ptr< EnergySource > | source | ) |
source | Pointer to an EnergySource. |
Creates an EnergySourceContianer with exactly one EnergySource previously instantiated.
ns3::EnergySourceContainer::EnergySourceContainer | ( | std::string | sourceName | ) |
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.
ns3::EnergySourceContainer::EnergySourceContainer | ( | const EnergySourceContainer & | a, | |
const EnergySourceContainer & | b | |||
) |
a | A EnergySourceContainer. | |
b | Another EnergySourceContainer. |
Creates an EnergySourceContainer by concatenating EnergySourceContainer b to EnergySourceContainer a.
void ns3::EnergySourceContainer::Add | ( | EnergySourceContainer | container | ) |
container | Another EnergySourceContainer to append. |
Appends the contents of another EnergySourceContainer to the end of this EnergySourceContainer.
void ns3::EnergySourceContainer::Add | ( | std::string | sourceName | ) |
Append a single Ptr<EnergySource> referred to by its object name to the end of this container.
sourceName | Name of EnergySource object. |
void ns3::EnergySourceContainer::Add | ( | Ptr< EnergySource > | source | ) |
Append a single Ptr<EnergySource> to the end of this container.
source | Pointer to an EnergySource. |
Iterator ns3::EnergySourceContainer::Begin | ( | void | ) | const |
Get an iterator which refers to the first EnergySource pointer in the 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 }
Iterator ns3::EnergySourceContainer::End | ( | void | ) | const |
Get an iterator which refers to the last EnergySource pointer in the 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 }
Ptr<EnergySource> ns3::EnergySourceContainer::Get | ( | uint32_t | i | ) | const |
Get the i-th Ptr<EnergySource> stored in this container.
i | Index of the requested Ptr<EnergySource>. |
uint32_t ns3::EnergySourceContainer::GetN | ( | void | ) | const |
Get the number of Ptr<EnergySource> stored in this container.
static TypeId ns3::EnergySourceContainer::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::Object.
This object is accessible through the following paths with Config::Set and Config::Connect:
No Attributes defined for this type.
No TraceSources defined for this type.
Reimplemented from ns3::Object.