Allocate buildings on a rectangular 2d grid. More...
#include "building-allocator.h"
Public Member Functions | |
GridBuildingAllocator () | |
virtual | ~GridBuildingAllocator () |
BuildingContainer | Create (uint32_t n) const |
Create a set of buildings allocated on a grid. More... | |
void | SetBuildingAttribute (std::string n, const AttributeValue &v) |
Set an attribute to be used for each new building to be created. More... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Get the most derived TypeId for this Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized (void) const |
Check if the object has been initialized. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= ([[maybe_unused]] const SimpleRefCount &o) |
Assignment operator. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
void | PushAttributes () const |
Pushes the attributes into the relevant position allocators. More... | |
Private Attributes | |
ObjectFactory | m_buildingFactory |
The building factory. More... | |
uint32_t | m_current |
current building number More... | |
double | m_deltaX |
The x space between buildings. More... | |
double | m_deltaY |
The y space between buildings. More... | |
double | m_height |
The height of the building (roof level) More... | |
enum GridPositionAllocator::LayoutType | m_layoutType |
Layout type. More... | |
double | m_lengthX |
The length of the wall of each building along the X axis. More... | |
double | m_lengthY |
The length of the wall of each building along the Y axis. More... | |
Ptr< GridPositionAllocator > | m_lowerLeftPositionAllocator |
The upper left position allocator. More... | |
uint32_t | m_n |
The number of objects laid out on a line. More... | |
Ptr< GridPositionAllocator > | m_upperRightPositionAllocator |
The upper right position allocator. More... | |
double | m_xMin |
The x coordinate where the grid starts. More... | |
double | m_yMin |
The y coordinate where the grid starts. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoDispose (void) |
Destructor implementation. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
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.
No TraceSources are defined for this type.
Size of this type is 152 bytes (on a 64-bit architecture).
Definition at line 44 of file building-allocator.h.
ns3::GridBuildingAllocator::GridBuildingAllocator | ( | ) |
Definition at line 36 of file building-allocator.cc.
References m_buildingFactory, m_lowerLeftPositionAllocator, m_upperRightPositionAllocator, and ns3::ObjectFactory::SetTypeId().
|
virtual |
Definition at line 44 of file building-allocator.cc.
BuildingContainer ns3::GridBuildingAllocator::Create | ( | uint32_t | n | ) | const |
Create a set of buildings allocated on a grid.
n | the number of buildings to create |
Definition at line 104 of file building-allocator.cc.
References ns3::BuildingContainer::Add(), ns3::ObjectFactory::Create(), m_buildingFactory, m_current, m_height, m_lowerLeftPositionAllocator, m_upperRightPositionAllocator, NS_LOG_FUNCTION, NS_LOG_LOGIC, PushAttributes(), and ns3::ObjectFactory::Set().
|
static |
Get the type ID.
Definition at line 49 of file building-allocator.cc.
References 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::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeUintegerAccessor(), ns3::GridPositionAllocator::ROW_FIRST, and ns3::TypeId::SetParent().
|
private |
Pushes the attributes into the relevant position allocators.
Definition at line 125 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().
void ns3::GridBuildingAllocator::SetBuildingAttribute | ( | std::string | n, |
const AttributeValue & | v | ||
) |
Set an attribute to be used for each new building to be created.
n | attribute name |
v | attribute value |
Definition at line 97 of file building-allocator.cc.
References m_buildingFactory, NS_LOG_FUNCTION, and ns3::ObjectFactory::Set().
|
mutableprivate |
The building factory.
Definition at line 90 of file building-allocator.h.
Referenced by GridBuildingAllocator(), Create(), and SetBuildingAttribute().
|
mutableprivate |
|
private |
The x space between buildings.
Definition at line 86 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The y space between buildings.
Definition at line 87 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The height of the building (roof level)
Definition at line 88 of file building-allocator.h.
Referenced by Create(), and GetTypeId().
|
private |
Layout type.
Definition at line 79 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The length of the wall of each building along the X axis.
Definition at line 84 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The length of the wall of each building along the Y axis.
Definition at line 85 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The upper left position allocator.
Definition at line 91 of file building-allocator.h.
Referenced by GridBuildingAllocator(), Create(), and PushAttributes().
|
private |
The number of objects laid out on a line.
Definition at line 83 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The upper right position allocator.
Definition at line 92 of file building-allocator.h.
Referenced by GridBuildingAllocator(), Create(), and PushAttributes().
|
private |
The x coordinate where the grid starts.
Definition at line 81 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().
|
private |
The y coordinate where the grid starts.
Definition at line 82 of file building-allocator.h.
Referenced by GetTypeId(), and PushAttributes().