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

#include "building-list.h"

Public Types

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

Static Public Member Functions

static uint32_t Add (Ptr< Building > building)
 
static Iterator Begin (void)
 
static Iterator End (void)
 
static Ptr< BuildingGetBuilding (uint32_t n)
 
static uint32_t GetNBuildings (void)
 

Detailed Description

Definition at line 33 of file building-list.h.

Member Typedef Documentation

◆ Iterator

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

Definition at line 36 of file building-list.h.

Member Function Documentation

◆ Add()

uint32_t ns3::BuildingList::Add ( Ptr< Building building)
static
Parameters
buildingbuilding to add
Returns
index of building in list.

This method is called automatically from Building::Building so the user has little reason to call it himself.

Definition at line 168 of file building-list.cc.

References ns3::BuildingListPriv::Get().

Referenced by ns3::Building::Building().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Begin()

BuildingList::Iterator ns3::BuildingList::Begin ( void  )
static

◆ End()

BuildingList::Iterator ns3::BuildingList::End ( void  )
static

◆ GetBuilding()

Ptr< Building > ns3::BuildingList::GetBuilding ( uint32_t  n)
static
Parameters
nindex of requested building.
Returns
the Building associated to index n.

Definition at line 183 of file building-list.cc.

References ns3::BuildingListPriv::Get(), and sample-rng-plot::n.

Referenced by ns3::RandomBuildingPositionAllocator::GetNext().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetNBuildings()

uint32_t ns3::BuildingList::GetNBuildings ( void  )
static
Returns
the number of buildings currently in the list.

Definition at line 188 of file building-list.cc.

References ns3::BuildingListPriv::Get().

Referenced by ns3::RandomBuildingPositionAllocator::GetNext(), ns3::OutdoorPositionAllocator::GetNext(), and ns3::RandomRoomPositionAllocator::GetNext().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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