A Discrete-Event Network Simulator
API
ns3::GridPositionAllocator Class Reference

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

#include "position-allocator.h"

+ Inheritance diagram for ns3::GridPositionAllocator:
+ Collaboration diagram for ns3::GridPositionAllocator:

Public Types

enum  LayoutType { ROW_FIRST , COLUMN_FIRST }
 Determine whether positions are allocated row first or column first. More...
 

Public Member Functions

 GridPositionAllocator ()
 
virtual int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
double GetDeltaX (void) const
 
double GetDeltaY (void) const
 
enum LayoutType GetLayoutType (void) const
 
double GetMinX (void) const
 
double GetMinY (void) const
 
uint32_t GetN (void) const
 
virtual Vector GetNext (void) const
 
void SetDeltaX (double deltaX)
 
void SetDeltaY (double deltaY)
 
void SetLayoutType (enum LayoutType layoutType)
 
void SetMinX (double xMin)
 
void SetMinY (double yMin)
 
void SetN (uint32_t n)
 
void SetZ (double z)
 
- Public Member Functions inherited from ns3::PositionAllocator
 PositionAllocator ()
 
virtual ~PositionAllocator ()
 
virtual int64_t AssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual Vector GetNext (void) const =0
 
- 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< ObjectGetObject () 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< ObjectGetObject (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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::PositionAllocator
static TypeId GetTypeId (void)
 Register this type with the TypeId system. 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 Attributes

uint32_t m_current
 currently position More...
 
double m_deltaX
 x interval between two consecutive x positions More...
 
double m_deltaY
 y interval between two consecutive y positions More...
 
enum LayoutType m_layoutType
 currently selected layout type More...
 
uint32_t m_n
 number of positions to allocate on each row or column More...
 
double m_xMin
 minimum boundary on x positions More...
 
double m_yMin
 minimum boundary on y positions More...
 
double m_z
 z coordinate of all the positions generated 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...
 

Detailed Description

Allocate positions on a rectangular 2d grid.

Config Paths

ns3::GridPositionAllocator is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::GridPositionAllocator"

Attributes

  • 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
  • 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
  • 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
  • Z: The z coordinate of all the positions allocated.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: constructwriteread
  • DeltaX: The x space between objects.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: constructwriteread
  • DeltaY: The y space between objects.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: constructwriteread
  • LayoutType: The type of layout.
    • Set with class: ns3::EnumValue
    • Underlying type: RowFirst|ColumnFirst
    • Initial value: RowFirst
    • Flags: constructwriteread

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

Definition at line 125 of file position-allocator.h.

Member Enumeration Documentation

◆ LayoutType

Determine whether positions are allocated row first or column first.

Enumerator
ROW_FIRST 

In row-first mode, positions are allocated on the first row until N positions have been allocated.

Then, the second row located a yMin + yDelta is used to allocate positions.

COLUMN_FIRST 

In column-first mode, positions are allocated on the first column until N positions have been allocated.

Then, the second column located a xMin + xDelta is used to allocate positions.

Definition at line 137 of file position-allocator.h.

Constructor & Destructor Documentation

◆ GridPositionAllocator()

ns3::GridPositionAllocator::GridPositionAllocator ( )

Definition at line 186 of file position-allocator.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::GridPositionAllocator::AssignStreams ( int64_t  stream)
virtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

This method must be implement in subclasses.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

Definition at line 288 of file position-allocator.cc.

◆ GetDeltaX()

double ns3::GridPositionAllocator::GetDeltaX ( void  ) const
Returns
the x interval between two consecutive x-positions.

Definition at line 245 of file position-allocator.cc.

References m_deltaX.

◆ GetDeltaY()

double ns3::GridPositionAllocator::GetDeltaY ( void  ) const
Returns
the y interval between two consecutive y-positions.

Definition at line 251 of file position-allocator.cc.

References m_deltaY.

◆ GetLayoutType()

enum GridPositionAllocator::LayoutType ns3::GridPositionAllocator::GetLayoutType ( void  ) const
Returns
the currently-selected layout type.

Definition at line 263 of file position-allocator.cc.

References m_layoutType.

◆ GetMinX()

double ns3::GridPositionAllocator::GetMinX ( void  ) const
Returns
the x coordinate of the first allocated position.

Definition at line 233 of file position-allocator.cc.

References m_xMin.

◆ GetMinY()

double ns3::GridPositionAllocator::GetMinY ( void  ) const
Returns
the y coordinate of the first allocated position.

Definition at line 239 of file position-allocator.cc.

References m_yMin.

◆ GetN()

uint32_t ns3::GridPositionAllocator::GetN ( void  ) const
Returns
the number of positions to allocate on each row or each column.

Definition at line 257 of file position-allocator.cc.

References m_n.

◆ GetNext()

Vector ns3::GridPositionAllocator::GetNext ( void  ) const
virtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

Definition at line 269 of file position-allocator.cc.

References COLUMN_FIRST, m_current, m_deltaX, m_deltaY, m_layoutType, m_n, m_xMin, m_yMin, m_z, and ROW_FIRST.

◆ GetTypeId()

TypeId ns3::GridPositionAllocator::GetTypeId ( void  )
static

Register this type with the TypeId system.

Returns
the object TypeId

Definition at line 146 of file position-allocator.cc.

References COLUMN_FIRST, m_deltaX, m_deltaY, m_layoutType, m_n, m_xMin, m_yMin, m_z, ns3::MakeDoubleAccessor(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeUintegerAccessor(), ROW_FIRST, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetDeltaX()

void ns3::GridPositionAllocator::SetDeltaX ( double  deltaX)
Parameters
deltaXthe x interval between two x-consecutive positions.

Definition at line 209 of file position-allocator.cc.

References m_deltaX.

◆ SetDeltaY()

void ns3::GridPositionAllocator::SetDeltaY ( double  deltaY)
Parameters
deltaYthe y interval between two y-consecutive positions.

Definition at line 215 of file position-allocator.cc.

References m_deltaY.

◆ SetLayoutType()

void ns3::GridPositionAllocator::SetLayoutType ( enum LayoutType  layoutType)
Parameters
layoutTypethe type of layout to use (row first or column first).

Definition at line 227 of file position-allocator.cc.

References m_layoutType.

◆ SetMinX()

void ns3::GridPositionAllocator::SetMinX ( double  xMin)
Parameters
xMinthe x coordinate where layout will start.

Definition at line 191 of file position-allocator.cc.

References m_xMin.

◆ SetMinY()

void ns3::GridPositionAllocator::SetMinY ( double  yMin)
Parameters
yMinthe y coordinate where layout will start

Definition at line 197 of file position-allocator.cc.

References m_yMin.

◆ SetN()

void ns3::GridPositionAllocator::SetN ( uint32_t  n)
Parameters
nthe number of positions allocated on each row (or each column) before switching to the next column (or row).

Definition at line 221 of file position-allocator.cc.

References m_n.

◆ SetZ()

void ns3::GridPositionAllocator::SetZ ( double  z)
Parameters
zthe Z coordinate of all the positions allocated

Definition at line 203 of file position-allocator.cc.

References m_z.

Member Data Documentation

◆ m_current

uint32_t ns3::GridPositionAllocator::m_current
mutableprivate

currently position

Definition at line 215 of file position-allocator.h.

Referenced by GetNext().

◆ m_deltaX

double ns3::GridPositionAllocator::m_deltaX
private

x interval between two consecutive x positions

Definition at line 221 of file position-allocator.h.

Referenced by GetDeltaX(), GetNext(), GetTypeId(), and SetDeltaX().

◆ m_deltaY

double ns3::GridPositionAllocator::m_deltaY
private

y interval between two consecutive y positions

Definition at line 222 of file position-allocator.h.

Referenced by GetDeltaY(), GetNext(), GetTypeId(), and SetDeltaY().

◆ m_layoutType

enum LayoutType ns3::GridPositionAllocator::m_layoutType
private

currently selected layout type

Definition at line 216 of file position-allocator.h.

Referenced by GetLayoutType(), GetNext(), GetTypeId(), and SetLayoutType().

◆ m_n

uint32_t ns3::GridPositionAllocator::m_n
private

number of positions to allocate on each row or column

Definition at line 220 of file position-allocator.h.

Referenced by GetN(), GetNext(), GetTypeId(), and SetN().

◆ m_xMin

double ns3::GridPositionAllocator::m_xMin
private

minimum boundary on x positions

Definition at line 217 of file position-allocator.h.

Referenced by GetMinX(), GetNext(), GetTypeId(), and SetMinX().

◆ m_yMin

double ns3::GridPositionAllocator::m_yMin
private

minimum boundary on y positions

Definition at line 218 of file position-allocator.h.

Referenced by GetMinY(), GetNext(), GetTypeId(), and SetMinY().

◆ m_z

double ns3::GridPositionAllocator::m_z
private

z coordinate of all the positions generated

Definition at line 219 of file position-allocator.h.

Referenced by GetNext(), GetTypeId(), and SetZ().


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