Allocate the positions uniformely (with constant density) randomly within a disc. More...

#include <position-allocator.h>

Inheritance diagram for ns3::UniformDiscPositionAllocator:

Collaboration diagram for ns3::UniformDiscPositionAllocator:

Public Member Functions
	UniformDiscPositionAllocator ()
virtual	~UniformDiscPositionAllocator ()
virtual int64_t	AssignStreams (int64_t stream)
virtual Vector	GetNext (void) const
void	SetRho (double rho)
void	SetX (double x)
void	SetY (double 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	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::UniformDiscPositionAllocator.

Private Attributes
double	m_rho
Ptr< UniformRandomVariable >	m_rv
double	m_x
double	m_y

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 the positions uniformely (with constant density) randomly within a disc.

UniformDiscPositionAllocator allocates the positions randomly within a disc $ D $ lying on the plane $ z=0 $ and having center at coordinates $ (x,y,0) $ and radius $\rho$ . The random positions are chosen such that, for any subset $S \subset D$ , the expected value of the fraction of points which fall into $S \subset D$ corresponds to $\frac{|S|}{|D|}$ , i.e., to the ratio of the area of the subset to the area of the whole disc.

Note: using UniformDiscPositionAllocator is not equivalent to using a RandomDiscPositionAllocator with a uniformly-distributed radius, since doing that would results in a point distribution which is more dense towards the center of the disc.

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

Constructor & Destructor Documentation

ns3::UniformDiscPositionAllocator::UniformDiscPositionAllocator ( )

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

References m_rv.

ns3::UniformDiscPositionAllocator::~UniformDiscPositionAllocator ( )

virtual

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

Member Function Documentation

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

References m_rv, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

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

virtual

Returns: the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References ns3::UniformRandomVariable::GetValue(), m_rho, m_rv, m_x, m_y, NS_LOG_DEBUG, and sample-rng-plot::x.

Here is the call graph for this function:

TypeId ns3::UniformDiscPositionAllocator::GetTypeId ( void )

static

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

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

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

Attributes defined for this type:

rho: The radius of the disc
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
X: The x coordinate of the center of the disc.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
Y: The y coordinate of the center of the disc.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read