A Discrete-Event Network Simulator
API
ns3::BuildingContainer Class Reference

keep track of a set of building pointers. More...

#include "building-container.h"

+ Collaboration diagram for ns3::BuildingContainer:

Public Types

typedef std::vector< Ptr< Building > >::const_iterator Iterator
 

Public Member Functions

 BuildingContainer ()
 Create an empty BuildingContainer. More...
 
 BuildingContainer (Ptr< Building > building)
 Create a BuildingContainer with exactly one building which has been previously instantiated. More...
 
 BuildingContainer (std::string buildingName)
 Create a BuildingContainer with exactly one building which has been previously instantiated and assigned a name using the Object Name Service. More...
 
void Add (BuildingContainer other)
 Append the contents of another BuildingContainer to the end of this container. More...
 
void Add (Ptr< Building > building)
 Append a single Ptr<Building> to this container. More...
 
void Add (std::string buildingName)
 Append to this container the single Ptr<Building> referred to via its object name service registered name. More...
 
Iterator Begin (void) const
 Get an iterator which refers to the first Building in the container. More...
 
void Create (uint32_t n)
 Create n buildings and append pointers to them to the end of this BuildingContainer. More...
 
Iterator End (void) const
 Get an iterator which indicates past-the-last Building in the container. More...
 
Ptr< BuildingGet (uint32_t i) const
 Get the Ptr<Building> stored in this container at a given index. More...
 
uint32_t GetN (void) const
 Get the number of Ptr<Building> stored in this container. More...
 

Static Public Member Functions

static BuildingContainer GetGlobal (void)
 Create a BuildingContainer that contains a list of all buildings stored in the ns3::BuildingList. More...
 

Private Attributes

std::vector< Ptr< Building > > m_buildings
 

Detailed Description

keep track of a set of building pointers.

Some ns-3 helpers operate on more than one building at a time. For example a PositionAllocator may want to position nodes on a set of buildings. The helper methods will then usually take a BuildingContainer as a parameter. BuildingContainers hold the multiple Ptr<Building> which are used to refer to the buildings.

Definition at line 40 of file building-container.h.

Member Typedef Documentation

typedef std::vector<Ptr<Building> >::const_iterator ns3::BuildingContainer::Iterator

Definition at line 43 of file building-container.h.

Constructor & Destructor Documentation

ns3::BuildingContainer::BuildingContainer ( )

Create an empty BuildingContainer.

Definition at line 28 of file building-container.cc.

ns3::BuildingContainer::BuildingContainer ( Ptr< Building building)

Create a BuildingContainer with exactly one building which has been previously instantiated.

The single Building is specified by a smart pointer.

Parameters
buildingThe Ptr<Building> to add to the container.

Definition at line 32 of file building-container.cc.

References m_buildings.

ns3::BuildingContainer::BuildingContainer ( std::string  buildingName)

Create a BuildingContainer with exactly one building which has been previously instantiated and assigned a name using the Object Name Service.

This Building is then specified by its assigned name.

Parameters
buildingNameThe name of the Building Object to add to the container.

Definition at line 36 of file building-container.cc.

References m_buildings.

Member Function Documentation

void ns3::BuildingContainer::Add ( BuildingContainer  other)

Append the contents of another BuildingContainer to the end of this container.

Parameters
otherThe BuildingContainer to append.

Definition at line 72 of file building-container.cc.

References Begin(), End(), and m_buildings.

Referenced by ns3::GridBuildingAllocator::Create(), and GetGlobal().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::BuildingContainer::Add ( Ptr< Building building)

Append a single Ptr<Building> to this container.

Parameters
buildingThe Ptr<Building> to append.

Definition at line 80 of file building-container.cc.

References m_buildings.

void ns3::BuildingContainer::Add ( std::string  buildingName)

Append to this container the single Ptr<Building> referred to via its object name service registered name.

Parameters
buildingNameThe name of the Building Object to add to the container.

Definition at line 85 of file building-container.cc.

References m_buildings.

BuildingContainer::Iterator ns3::BuildingContainer::Begin ( void  ) const

Get an iterator which refers to the first Building in the container.

Buildings 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 Buildings

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some Building method
}
Returns
an iterator which refers to the first Building in the container.

Definition at line 43 of file building-container.cc.

References m_buildings.

Referenced by Add().

+ Here is the caller graph for this function:

void ns3::BuildingContainer::Create ( uint32_t  n)

Create n buildings and append pointers to them to the end of this BuildingContainer.

Buildings are at the heart of any ns-3 simulation. One of the first tasks that any simulation needs to do is to create a number of buildings. This method automates that task.

Parameters
nThe number of Buildings to create

Definition at line 64 of file building-container.cc.

References m_buildings, and sample-rng-plot::n.

BuildingContainer::Iterator ns3::BuildingContainer::End ( void  ) const

Get an iterator which indicates past-the-last Building in the container.

Buildings 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 Buildings

for (i = container.Begin (); i != container.End (); ++i)
{
(*i)->method (); // some Building method
}
Returns
an iterator which indicates an ending condition for a loop.

Definition at line 48 of file building-container.cc.

References m_buildings.

Referenced by Add().

+ Here is the caller graph for this function:

Ptr< Building > ns3::BuildingContainer::Get ( uint32_t  i) const

Get the Ptr<Building> stored in this container at a given index.

Buildings 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 direct method and is used to retrieve the indexed Ptr<Appliation>.

uint32_t nBuildings = container.GetN ();
for (uint32_t i = 0 i < nBuildings; ++i)
{
Ptr<Building> p = container.Get (i)
i->method (); // some Building method
}
Parameters
ithe index of the requested building pointer.
Returns
the requested building pointer.

Definition at line 59 of file building-container.cc.

References m_buildings.

BuildingContainer ns3::BuildingContainer::GetGlobal ( void  )
static

Create a BuildingContainer that contains a list of all buildings stored in the ns3::BuildingList.

Whenever a Building is created, a Ptr<Building> is added to a global list of all buildings in the system. It is sometimes useful to be able to get to all buildings in one place. This method creates a BuildingContainer that is initialized to contain all of the simulation buildings,

Returns
a BuildingContainer which contains a list of all Buildings.

Definition at line 92 of file building-container.cc.

References Add(), ns3::BuildingList::Begin(), and ns3::BuildingList::End().

+ Here is the call graph for this function:

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

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

Buildings 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 direct method and is typically used to define an ending condition in a for-loop that runs through the stored Buildings

uint32_t nBuildings = container.GetN ();
for (uint32_t i = 0 i < nBuildings; ++i)
{
Ptr<Building> p = container.Get (i)
i->method (); // some Building method
}
Returns
the number of Ptr<Building> stored in this container.

Definition at line 54 of file building-container.cc.

References m_buildings.

Member Data Documentation

std::vector<Ptr<Building> > ns3::BuildingContainer::m_buildings
private

Definition at line 203 of file building-container.h.

Referenced by Add(), Begin(), BuildingContainer(), Create(), End(), Get(), and GetN().


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