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 ()

	~GridBuildingAllocator () override

BuildingContainer	Create (uint32_t n) const
	Create a set of buildings allocated on a grid.

void	SetBuildingAttribute (std::string n, const AttributeValue &v)
	Set an attribute to be used for each new building to be created.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T>
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
void	PushAttributes () const
	Pushes the attributes into the relevant position allocators.

Private Attributes
ObjectFactory	m_buildingFactory
	The building factory.

uint32_t	m_current
	Current building number.

double	m_deltaX
	The x space between buildings.

double	m_deltaY
	The y space between buildings.

double	m_height
	The height of the building (roof level)

GridPositionAllocator::LayoutType	m_layoutType
	Layout type.

double	m_lengthX
	The length of the wall of each building along the X axis.

double	m_lengthY
	The length of the wall of each building along the Y axis.

Ptr< GridPositionAllocator >	m_lowerLeftPositionAllocator
	The upper left position allocator.

uint32_t	m_n
	The number of objects laid out on a line.

Ptr< GridPositionAllocator >	m_upperRightPositionAllocator
	The upper right position allocator.

double	m_xMin
	The x coordinate where the grid starts.

double	m_yMin
	The y coordinate where the grid starts.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Allocate buildings on a rectangular 2d grid.

Introspection did not find any typical Config paths

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.

Attributes

DeltaX: The x space between buildings.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: constructwriteread
- Support level: SUPPORTED
DeltaY: The y space between buildings.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: constructwriteread
- Support level: SUPPORTED
GridWidth: The number of objects laid out on a line.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED
LayoutType: The type of layout.
- Set with class: ns3::EnumValue<ns3::GridPositionAllocator::LayoutType>
- Underlying type: RowFirst|ColumnFirst
- Initial value: RowFirst
- Flags: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type
Group: Buildings
Size of this type is 176 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ GridBuildingAllocator()

ns3::GridBuildingAllocator::GridBuildingAllocator ( )

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

References ns3::CreateObject(), m_buildingFactory, m_current, m_lowerLeftPositionAllocator, and m_upperRightPositionAllocator.

Here is the call graph for this function:

◆ ~GridBuildingAllocator()

ns3::GridBuildingAllocator::~GridBuildingAllocator ( )

override

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

Member Function Documentation

◆ Create()

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 108 of file building-allocator.cc.

References ns3::BuildingContainer::Add(), m_buildingFactory, m_current, m_height, m_lowerLeftPositionAllocator, m_upperRightPositionAllocator, NS_LOG_FUNCTION, NS_LOG_LOGIC, and PushAttributes().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::GridBuildingAllocator::GetTypeId ( )

static

Get the type ID.

Returns: The object TypeId.

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

References ns3::Object::Object(), ns3::GridPositionAllocator::COLUMN_FIRST, m_deltaX, m_deltaY, m_height, m_layoutType, m_lengthX, m_lengthY, m_n, m_xMin, m_yMin, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::GridPositionAllocator::ROW_FIRST, and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ PushAttributes()

void ns3::GridBuildingAllocator::PushAttributes ( ) const

private

Pushes the attributes into the relevant position allocators.

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

References m_deltaX, m_deltaY, m_layoutType, m_lengthX, m_lengthY, m_lowerLeftPositionAllocator, m_n, m_upperRightPositionAllocator, m_xMin, m_yMin, and NS_LOG_FUNCTION.

Referenced by Create().

Here is the caller graph for this function:

◆ SetBuildingAttribute()

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

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

References m_buildingFactory, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_buildingFactory

ObjectFactory ns3::GridBuildingAllocator::m_buildingFactory

mutableprivate

The building factory.

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

Referenced by GridBuildingAllocator(), Create(), and SetBuildingAttribute().

◆ m_current

uint32_t ns3::GridBuildingAllocator::m_current

mutableprivate

Current building number.

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

Referenced by GridBuildingAllocator(), and Create().

◆ m_deltaX

double ns3::GridBuildingAllocator::m_deltaX

private

The x space between buildings.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_deltaY

double ns3::GridBuildingAllocator::m_deltaY

private

The y space between buildings.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_height

double ns3::GridBuildingAllocator::m_height

private

The height of the building (roof level)

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

Referenced by Create(), and GetTypeId().

◆ m_layoutType

GridPositionAllocator::LayoutType ns3::GridBuildingAllocator::m_layoutType

private

Layout type.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_lengthX

double ns3::GridBuildingAllocator::m_lengthX

private

The length of the wall of each building along the X axis.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_lengthY

double ns3::GridBuildingAllocator::m_lengthY

private

The length of the wall of each building along the Y axis.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_lowerLeftPositionAllocator

Ptr<GridPositionAllocator> ns3::GridBuildingAllocator::m_lowerLeftPositionAllocator

private

The upper left position allocator.

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

Referenced by GridBuildingAllocator(), Create(), and PushAttributes().

◆ m_n

uint32_t ns3::GridBuildingAllocator::m_n

private

The number of objects laid out on a line.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_upperRightPositionAllocator

Ptr<GridPositionAllocator> ns3::GridBuildingAllocator::m_upperRightPositionAllocator

private

The upper right position allocator.

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

Referenced by GridBuildingAllocator(), Create(), and PushAttributes().

◆ m_xMin

double ns3::GridBuildingAllocator::m_xMin

private

The x coordinate where the grid starts.

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

Referenced by GetTypeId(), and PushAttributes().

◆ m_yMin

double ns3::GridBuildingAllocator::m_yMin

private

The y coordinate where the grid starts.

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

Referenced by GetTypeId(), and PushAttributes().

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

src/buildings/helper/building-allocator.h
src/buildings/helper/building-allocator.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ GridBuildingAllocator()

◆ ~GridBuildingAllocator()

Member Function Documentation

◆ Create()

◆ GetTypeId()

◆ PushAttributes()

◆ SetBuildingAttribute()

Member Data Documentation

◆ m_buildingFactory

◆ m_current

◆ m_deltaX

◆ m_deltaY

◆ m_height

◆ m_layoutType

◆ m_lengthX

◆ m_lengthY

◆ m_lowerLeftPositionAllocator

◆ m_n

◆ m_upperRightPositionAllocator

◆ m_xMin

◆ m_yMin