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)
Public Member Functions inherited from ns3::PositionAllocator
	PositionAllocator ()
virtual	~PositionAllocator ()
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
	Implement the GetInstanceTypeId method defined in ObjectBase. More...
template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. 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 ()
	Constructor. More...
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (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
	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)
	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::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 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...

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

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:
  • Initial value: RowFirst
  • Flags: construct write read

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

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

Constructor & Destructor Documentation

ns3::GridPositionAllocator::GridPositionAllocator

(

)

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

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

double ns3::GridPositionAllocator::GetDeltaX

(

void

)

const

Returns

the x interval between two consecutive x-positions.

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

References m_deltaX.

double ns3::GridPositionAllocator::GetDeltaY

(

void

)

const

Returns

the y interval between two consecutive y-positions.

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

References m_deltaY.

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

(

void

)

const

Returns

the currently-selected layout type.

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

References m_layoutType.

double ns3::GridPositionAllocator::GetMinX

(

void

)

const

Returns

the x coordinate of the first allocated position.

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

References m_xMin.

double ns3::GridPositionAllocator::GetMinY

(

void

)

const

Returns

the y coordinate of the first allocated position.

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

References m_yMin.

uint32_t ns3::GridPositionAllocator::GetN

(

void

)

const

Returns

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

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

References m_n.

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

References COLUMN_FIRST, m_current, m_deltaX, m_deltaY, m_layoutType, m_n, m_xMin, m_yMin, ROW_FIRST, and sample-rng-plot::x.

TypeId ns3::GridPositionAllocator::GetTypeId ( void  )

static

Register this type with the TypeId system.

Returns

the object TypeId

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

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

Here is the call graph for this function:

void ns3::GridPositionAllocator::SetDeltaX

(

double

deltaX

)

Parameters

deltaX

the x interval between two x-consecutive positions.

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

References m_deltaX.

void ns3::GridPositionAllocator::SetDeltaY

(

double

deltaY

)

Parameters

deltaY

the y interval between two y-consecutive positions.

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

References m_deltaY.

void ns3::GridPositionAllocator::SetLayoutType

(

enum LayoutType

layoutType

)

Parameters

layoutType

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

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

References m_layoutType.

void ns3::GridPositionAllocator::SetMinX

(

double

xMin

)

Parameters

xMin	the x coordinate where layout will start.

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

References m_xMin.

void ns3::GridPositionAllocator::SetMinY

(

double

yMin

)

Parameters

yMin	the y coordinate where layout will start

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

References m_yMin.

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

References m_n.

Member Data Documentation

uint32_t ns3::GridPositionAllocator::m_current

mutableprivate

currently position

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

Referenced by GetNext().

double ns3::GridPositionAllocator::m_deltaX

private

x interval between two consecutive x positions

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

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

double ns3::GridPositionAllocator::m_deltaY

private

y interval between two consecutive y positions

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

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

enum LayoutType ns3::GridPositionAllocator::m_layoutType

private

currently selected layout type

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

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

uint32_t ns3::GridPositionAllocator::m_n

private

number of positions to allocate on each row or column

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

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

double ns3::GridPositionAllocator::m_xMin

private

minimum boundary on x positions

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

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

double ns3::GridPositionAllocator::m_yMin

private

minimum boundary on y positions

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

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

---

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

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