ns3::GridBuildingAllocator Class Reference

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

#include <building-allocator.h>

Inheritance diagram for ns3::GridBuildingAllocator:

Collaboration diagram for ns3::GridBuildingAllocator:

List of all members.

Public Member Functions
void	SetBuildingAttribute (std::string n, const AttributeValue &v)
BuildingContainer	Create (uint32_t n) const
Public Member Functions inherited from ns3::Object
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Dispose (void)
void	AggregateObject (Ptr< Object > other)
AggregateIterator	GetAggregateIterator (void) const
void	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
uint32_t	GetReferenceCount (void) const
Public Member Functions inherited from ns3::ObjectBase
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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.

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

---

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.

---

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

References ns3::BuildingContainer::Add(), ns3::ObjectFactory::Create(), ns3::GridPositionAllocator::GetNext(), NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::ObjectFactory::Set(), ns3::Vector3D::x, and ns3::Vector3D::y.

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

No TraceSources defined for this type.

Reimplemented from ns3::Object.

References ns3::GridPositionAllocator::COLUMN_FIRST, ns3::GridPositionAllocator::ROW_FIRST, and ns3::TypeId::SetParent().

void ns3::GridBuildingAllocator::SetBuildingAttribute	(	std::string	n,
		const AttributeValue &	v
	)

Set an attribute to be used for each new building to be created

Parameters:

n	attribute name
v	attribute value

References NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().

---

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

• src/buildings/helper/building-allocator.h
• doc/introspected-doxygen.h
• src/buildings/helper/building-allocator.cc