Allocate buildings on a rectangular 2d grid. More...

#include <building-allocator.h>

Inheritance diagram for ns3::GridBuildingAllocator:

Collaboration diagram for ns3::GridBuildingAllocator:

Public Member Functions
	GridBuildingAllocator ()
virtual	~GridBuildingAllocator ()
BuildingContainer	Create (uint32_t n) const
void	SetBuildingAttribute (std::string n, const AttributeValue &v)
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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
virtual	~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)
	This method returns the TypeId associated to ns3::GridBuildingAllocator.

Private Member Functions
void	PushAttributes () const

Private Attributes
ObjectFactory	m_buildingFactory
uint32_t	m_current
double	m_deltaX
double	m_deltaY
double	m_height
enum GridPositionAllocator::LayoutType	m_layoutType
double	m_lengthX
double	m_lengthY
Ptr< GridPositionAllocator >	m_lowerLeftPositionAllocator
uint32_t	m_n
Ptr< GridPositionAllocator >	m_upperRightPositionAllocator
double	m_xMin
double	m_yMin

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

Allocate buildings on a rectangular 2d grid.

This class allows to create a set of buildings positioned on a rectangular 2D grid. Under the hood, this class uses two instances of GridPositionAllocator.

Definition at line 44 of file building-allocator.h.

Constructor & Destructor Documentation

ns3::GridBuildingAllocator::GridBuildingAllocator ( )

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

References m_buildingFactory, m_lowerLeftPositionAllocator, m_upperRightPositionAllocator, and ns3::ObjectFactory::SetTypeId().

Here is the call graph for this function:

ns3::GridBuildingAllocator::~GridBuildingAllocator ( )

virtual

Definition at line 44 of file building-allocator.cc.

Member Function Documentation

BuildingContainer ns3::GridBuildingAllocator::Create ( uint32_t n ) const

Create a set of buildings allocated on a grid

Parameters

n	the number of buildings to create

Returns: the BuildingContainer that contains the newly created buildings

Definition at line 103 of file building-allocator.cc.

References ns3::BuildingContainer::Add(), ns3::ObjectFactory::Create(), ns3::GridPositionAllocator::GetNext(), m_buildingFactory, m_current, m_height, m_lowerLeftPositionAllocator, m_upperRightPositionAllocator, NS_LOG_FUNCTION, NS_LOG_LOGIC, PushAttributes(), ns3::ObjectFactory::Set(), ns3::Vector3D::x, and ns3::Vector3D::y.

Referenced by FemtocellBlockAllocator::Create().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::GridBuildingAllocator::GetTypeId ( void )

static

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

Attributes defined for this type:

GridWidth: The number of objects layed out on a line.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
MinX: The x coordinate where the grid starts.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
MinY: The y coordinate where the grid starts.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
LengthX: the length of the wall of each building along the X axis.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
LengthY: the length of the wall of each building along the X axis.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
DeltaX: The x space between buildings.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
DeltaY: The y space between buildings.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
Height: The height of the building (roof level)
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 10
- Flags: construct write read
LayoutType: The type of layout.
- Set with class: ns3::EnumValue
- Underlying type: RowFirst|ColumnFirst
- Initial value: RowFirst
- Flags: construct write read