Allocate random positions within a disc according to a given distribution for the polar coordinates of each node with respect to the provided center of the disc. More...

#include "position-allocator.h"

Inheritance diagram for ns3::RandomDiscPositionAllocator:

Collaboration diagram for ns3::RandomDiscPositionAllocator:

Public Member Functions
	RandomDiscPositionAllocator ()

	~RandomDiscPositionAllocator () override

int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.

Vector	GetNext () const override

void	SetRho (Ptr< RandomVariableStream > rho)
	Set the random variable that generates position radius, in meters.

void	SetTheta (Ptr< RandomVariableStream > theta)
	Set the random variable that generates position angle, in radians.

void	SetX (double x)

void	SetY (double y)

void	SetZ (double z)

Public Member Functions inherited from ns3::PositionAllocator
	PositionAllocator ()

	~PositionAllocator () override

virtual int64_t	AssignStreams (int64_t stream)=0
	Assign a fixed random variable stream number to the random variables used by this model.

virtual Vector	GetNext () const =0

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type with the TypeId system.

Static Public Member Functions inherited from ns3::PositionAllocator
static TypeId	GetTypeId ()
	Register this type with the TypeId system.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
Ptr< RandomVariableStream >	m_rho
	pointer to rho's random variable stream

Ptr< RandomVariableStream >	m_theta
	pointer to theta's random variable stream

double	m_x
	x coordinate of center of disc

double	m_y
	y coordinate of center of disc

double	m_z
	z coordinate of the disc

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Allocate random positions within a disc according to a given distribution for the polar coordinates of each node with respect to the provided center of the disc.

Note: With the default uniform distribution over $2 \pi$ in theta and a uniform distribution for rho this position allocator will not uniformly populate the disc. The radial distribution will be proportional to $\frac{1}{r^2}$ .

To get a uniform distribution over a circle use the UniformDiscPositionAllocator.

Config Paths

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

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

Attributes

Rho: A random variable which represents the radius of a position in a random disc.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=200.0]
- Flags: constructwriteread
Theta: A random variable which represents the angle (gradients) of a position in a random disc.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=6.2830]
- Flags: constructwriteread
X: The x coordinate of the center of the random position disc.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: constructwriteread
Y: The y coordinate of the center of the random position disc.
- 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 in the disc.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: constructwriteread

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

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

Constructor & Destructor Documentation

◆ RandomDiscPositionAllocator()

ns3::RandomDiscPositionAllocator::RandomDiscPositionAllocator ( )

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

◆ ~RandomDiscPositionAllocator()

ns3::RandomDiscPositionAllocator::~RandomDiscPositionAllocator ( )

override

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

Member Function Documentation

◆ AssignStreams()

int64_t ns3::RandomDiscPositionAllocator::AssignStreams ( int64_t stream )

overridevirtual

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

References m_rho, m_theta, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

◆ GetNext()

Vector ns3::RandomDiscPositionAllocator::GetNext ( ) const

overridevirtual

Returns: the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References ns3::RandomVariableStream::GetValue(), m_rho, m_theta, m_x, m_y, m_z, and NS_LOG_DEBUG.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::RandomDiscPositionAllocator::GetTypeId ( )

static

Register this type with the TypeId system.

Returns: the object TypeId

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

References m_rho, m_theta, m_x, m_y, m_z, ns3::MakeDoubleAccessor(), ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetRho()

void ns3::RandomDiscPositionAllocator::SetRho ( Ptr< RandomVariableStream > rho )

Set the random variable that generates position radius, in meters.

Parameters

rho	Random variable that represents the radius of a position, in meters, in a random disc.

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

References m_rho.

◆ SetTheta()

void ns3::RandomDiscPositionAllocator::SetTheta ( Ptr< RandomVariableStream > theta )

Set the random variable that generates position angle, in radians.

Parameters

theta Random variable that represents the angle in radians of a position in a random disc.

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

References m_theta.

◆ SetX()

void ns3::RandomDiscPositionAllocator::SetX ( double x )

Parameters

x	the X coordinate of the center of the disc

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

References m_x.

◆ SetY()

void ns3::RandomDiscPositionAllocator::SetY ( double y )

Parameters

y	the Y coordinate of the center of the disc

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

References m_y.

◆ SetZ()

void ns3::RandomDiscPositionAllocator::SetZ ( double z )

Parameters

z	the Z coordinate of all the positions allocated

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

References m_z.

Member Data Documentation

◆ m_rho

Ptr<RandomVariableStream> ns3::RandomDiscPositionAllocator::m_rho

private

pointer to rho's random variable stream

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

Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetRho().

◆ m_theta

Ptr<RandomVariableStream> ns3::RandomDiscPositionAllocator::m_theta

private

pointer to theta's random variable stream

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

Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetTheta().

◆ m_x

double ns3::RandomDiscPositionAllocator::m_x

private

x coordinate of center of disc

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

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

◆ m_y

double ns3::RandomDiscPositionAllocator::m_y

private

y coordinate of center of disc

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

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

◆ m_z

double ns3::RandomDiscPositionAllocator::m_z

private

z coordinate of the disc

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

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

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ RandomDiscPositionAllocator()

◆ ~RandomDiscPositionAllocator()

Member Function Documentation

◆ AssignStreams()

◆ GetNext()

◆ GetTypeId()

◆ SetRho()

◆ SetTheta()

◆ SetX()

◆ SetY()

◆ SetZ()

Member Data Documentation

◆ m_rho

◆ m_theta

◆ m_x

◆ m_y

◆ m_z