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 ()
virtual	~RandomBoxPositionAllocator ()
virtual int64_t	AssignStreams (int64_t stream)
virtual Vector	GetNext (void) const
void	SetX (Ptr< RandomVariableStream > x)
void	SetY (Ptr< RandomVariableStream > y)
void	SetZ (Ptr< RandomVariableStream > z)
Public Member Functions inherited from ns3::PositionAllocator
	PositionAllocator ()
virtual	~PositionAllocator ()
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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
virtual	~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)
	This method returns the TypeId associated to ns3::RandomBoxPositionAllocator.

Private Attributes
Ptr< RandomVariableStream >	m_x
Ptr< RandomVariableStream >	m_y
Ptr< RandomVariableStream >	m_z

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

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

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

Constructor & Destructor Documentation

ns3::RandomBoxPositionAllocator::RandomBoxPositionAllocator ( )

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

ns3::RandomBoxPositionAllocator::~RandomBoxPositionAllocator ( )

virtual

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

Member Function Documentation

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

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

Here is the call graph for this function:

Vector ns3::RandomBoxPositionAllocator::GetNext ( void ) const

virtual

Returns: the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References ns3::RandomVariableStream::GetValue(), m_x, m_y, m_z, and sample-rng-plot::x.

Here is the call graph for this function:

TypeId ns3::RandomBoxPositionAllocator::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::RandomBoxPositionAllocator.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

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: construct write read
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: construct write read
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: construct write read