Allocate random positions within a rectangle according to a pair of random variables. More...

#include <position-allocator.h>

Inheritance diagram for ns3::RandomRectanglePositionAllocator:

Collaboration diagram for ns3::RandomRectanglePositionAllocator:

Public Member Functions
	RandomRectanglePositionAllocator ()

virtual	~RandomRectanglePositionAllocator ()

virtual int64_t	AssignStreams (int64_t stream)

virtual Vector	GetNext (void) const

void	SetX (Ptr< RandomVariableStream > x)

void	SetY (Ptr< RandomVariableStream > y)

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	Initialize (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)

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
Ptr< RandomVariableStream >	m_x

Ptr< RandomVariableStream >	m_y

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 random positions within a rectangle according to a pair of random variables.

Config Paths

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

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

Attributes

X: A random variable which represents the x coordinate of a position in a random rectangle.
- 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 rectangle.
- 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

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::RandomRectanglePositionAllocator::RandomRectanglePositionAllocator ( )

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

ns3::RandomRectanglePositionAllocator::~RandomRectanglePositionAllocator ( )

virtual

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

Member Function Documentation

int64_t ns3::RandomRectanglePositionAllocator::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