A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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:

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 ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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 Initialize (void)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. 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
 
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)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

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< GridPositionAllocatorm_lowerLeftPositionAllocator
 
uint32_t m_n
 
Ptr< GridPositionAllocatorm_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)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Allocate buildings on a rectangular 2d grid.

Doxygen 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

  • GridWidth: The number of objects layed out on a line.
  • 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 are defined for this type.

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

Constructor & Destructor Documentation

ns3::GridBuildingAllocator::GridBuildingAllocator ( )

Definition at line 37 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 45 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
nthe number of buildings to create
Returns
the BuildingContainer that contains the newly created buildings

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(), 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
void ns3::GridBuildingAllocator::PushAttributes ( ) const
private

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

+ Here is the caller graph for this function:

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

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

Parameters
nattribute name
vattribute value

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

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

Referenced by FemtocellBlockAllocator::Create().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

ObjectFactory ns3::GridBuildingAllocator::m_buildingFactory
mutableprivate

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

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

uint32_t ns3::GridBuildingAllocator::m_current
mutableprivate

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

Referenced by Create().

double ns3::GridBuildingAllocator::m_deltaX
private

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

Referenced by GetTypeId(), and PushAttributes().

double ns3::GridBuildingAllocator::m_deltaY
private

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

Referenced by GetTypeId(), and PushAttributes().

double ns3::GridBuildingAllocator::m_height
private

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

Referenced by Create(), and GetTypeId().

enum GridPositionAllocator::LayoutType ns3::GridBuildingAllocator::m_layoutType
private

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

Referenced by GetTypeId(), and PushAttributes().

double ns3::GridBuildingAllocator::m_lengthX
private

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

Referenced by GetTypeId(), and PushAttributes().

double ns3::GridBuildingAllocator::m_lengthY
private

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

Referenced by GetTypeId(), and PushAttributes().

Ptr<GridPositionAllocator> ns3::GridBuildingAllocator::m_lowerLeftPositionAllocator
private

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

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

uint32_t ns3::GridBuildingAllocator::m_n
private

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

Referenced by GetTypeId(), and PushAttributes().

Ptr<GridPositionAllocator> ns3::GridBuildingAllocator::m_upperRightPositionAllocator
private

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

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

double ns3::GridBuildingAllocator::m_xMin
private

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

Referenced by GetTypeId(), and PushAttributes().

double ns3::GridBuildingAllocator::m_yMin
private

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

Referenced by GetTypeId(), and PushAttributes().


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