Allocate random positions within a 3D box according to a set of three random variables. More...

#include "position-allocator.h"

Inheritance diagram for ns3::RandomBoxPositionAllocator:

Collaboration diagram for ns3::RandomBoxPositionAllocator:

Public Member Functions
	RandomBoxPositionAllocator ()

	~RandomBoxPositionAllocator () 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	SetX (Ptr< RandomVariableStream > x)
	Set the random variable stream object that generates x-positions.

void	SetY (Ptr< RandomVariableStream > y)
	Set the random variable stream object that generates y-positions.

void	SetZ (Ptr< RandomVariableStream > z)
	Set the random variable stream object that generates z-positions.

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_x
	pointer to x's random variable stream

Ptr< RandomVariableStream >	m_y
	pointer to y's random variable stream

Ptr< RandomVariableStream >	m_z
	pointer to z's random variable stream

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 3D box according to a set of three random variables.

Config Paths

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

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

Attributes

X: A random variable which represents the x coordinate of a position in a random box.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=1.0]
- Flags: constructwriteread
Y: A random variable which represents the y coordinate of a position in a random box.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=1.0]
- Flags: constructwriteread
Z: A random variable which represents the z coordinate of a position in a random box.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=1.0]
- Flags: constructwriteread

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

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

Constructor & Destructor Documentation

◆ RandomBoxPositionAllocator()

ns3::RandomBoxPositionAllocator::RandomBoxPositionAllocator ( )

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

◆ ~RandomBoxPositionAllocator()

ns3::RandomBoxPositionAllocator::~RandomBoxPositionAllocator ( )

override

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

Member Function Documentation

◆ AssignStreams()

int64_t ns3::RandomBoxPositionAllocator::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 441 of file position-allocator.cc.

References m_x, m_y, m_z, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

◆ GetNext()

Vector ns3::RandomBoxPositionAllocator::GetNext ( ) const

overridevirtual

Returns: the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

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

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::RandomBoxPositionAllocator::GetTypeId ( )

static

Register this type with the TypeId system.

Returns: the object TypeId

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

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

Here is the call graph for this function:

◆ SetX()

void ns3::RandomBoxPositionAllocator::SetX ( Ptr< RandomVariableStream > x )

Set the random variable stream object that generates x-positions.

Parameters

x	pointer to a RandomVariableStream object

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

References m_x.

◆ SetY()

void ns3::RandomBoxPositionAllocator::SetY ( Ptr< RandomVariableStream > y )

Set the random variable stream object that generates y-positions.

Parameters

y	pointer to a RandomVariableStream object

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

References m_y.

◆ SetZ()

void ns3::RandomBoxPositionAllocator::SetZ ( Ptr< RandomVariableStream > z )

Set the random variable stream object that generates z-positions.

Parameters

z	pointer to a RandomVariableStream object

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

References m_z.

Member Data Documentation

◆ m_x

Ptr<RandomVariableStream> ns3::RandomBoxPositionAllocator::m_x

private

pointer to x's random variable stream

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

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

◆ m_y

Ptr<RandomVariableStream> ns3::RandomBoxPositionAllocator::m_y

private

pointer to y's random variable stream

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

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

◆ m_z

Ptr<RandomVariableStream> ns3::RandomBoxPositionAllocator::m_z

private

pointer to z's random variable stream

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

Referenced by AssignStreams(), 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

◆ RandomBoxPositionAllocator()

◆ ~RandomBoxPositionAllocator()

Member Function Documentation

◆ AssignStreams()

◆ GetNext()

◆ GetTypeId()

◆ SetX()

◆ SetY()

◆ SetZ()

Member Data Documentation

◆ m_x

◆ m_y

◆ m_z