ns3::GridPositionAllocator Class Reference

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

#include <position-allocator.h>

Inheritance diagram for ns3::GridPositionAllocator:

Public Types
enum	LayoutType { ROW_FIRST, COLUMN_FIRST }

Public Member Functions
virtual int64_t	AssignStreams (int64_t stream)
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)
Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
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::PositionAllocator
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Attributes
uint32_t	m_current
double	m_deltaX
double	m_deltaY
enum LayoutType	m_layoutType
uint32_t	m_n
double	m_xMin
double	m_yMin

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

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 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
• DeltaX: The x space between objects.
  • 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 objects.
  • Set with class: ns3::DoubleValue
  • Underlying type: double -1.79769e+308:1.79769e+308
  • Initial value: 1
  • 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 88 of file position-allocator.h.

Member Enumeration Documentation

enum ns3::GridPositionAllocator::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 96 of file position-allocator.h.

Member Function Documentation

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

stream

first stream index to use

Returns

the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

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

double ns3::GridPositionAllocator::GetDeltaX

(

void

)

const

Returns

the x interval between two x-consecutive positions.

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

double ns3::GridPositionAllocator::GetDeltaY

(

void

)

const

Returns

the y interval between two y-consecutive positions.

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

enum GridPositionAllocator::LayoutType ns3::GridPositionAllocator::GetLayoutType

(

void

)

const

Returns

the currently-selected layout type.

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

double ns3::GridPositionAllocator::GetMinX

(

void

)

const

Returns

the x coordinate of the first allocated position.

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

double ns3::GridPositionAllocator::GetMinY

(

void

)

const

Returns

the y coordinate of the first allocated position.

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

uint32_t ns3::GridPositionAllocator::GetN

(

void

)

const

Returns

the number of positions to allocate on each row or each column.

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

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 193 of file position-allocator.cc.

References COLUMN_FIRST, and ROW_FIRST.

void ns3::GridPositionAllocator::SetDeltaX

(

double

deltaX

)

Parameters

deltaX

the x interval between two x-consecutive positions.

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

void ns3::GridPositionAllocator::SetDeltaY

(

double

deltaY

)

Parameters

deltaY

the y interval between two y-consecutive positions.

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

void ns3::GridPositionAllocator::SetLayoutType

(

enum LayoutType

layoutType

)

Parameters

layoutType

the type of layout to use (row first or column first).

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

void ns3::GridPositionAllocator::SetMinX

(

double

xMin

)

Parameters

xMin	the x coordinate where layout will start.

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

void ns3::GridPositionAllocator::SetMinY

(

double

yMin

)

Parameters

yMin	the y coordinate where layout will start

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

void ns3::GridPositionAllocator::SetN

(

uint32_t

n

)

Parameters

n	the number of positions allocated on each row (or each column) before switching to the next column (or row).

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

---

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

• src/mobility/model/position-allocator.h
• src/mobility/model/position-allocator.cc