A Discrete-Event Network Simulator
API
ns3::RandomDiscPositionAllocator Class Reference

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 ()
 
virtual ~RandomDiscPositionAllocator ()
 
virtual int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual Vector GetNext (void) const
 
void SetRho (Ptr< RandomVariableStream > rho)
 Set the random variable that generates position radius, in meters. More...
 
void SetTheta (Ptr< RandomVariableStream > theta)
 Set the random variable that generates position angle, in radians. More...
 
void SetX (double x)
 
void SetY (double y)
 
void SetZ (double z)
 
- Public Member Functions inherited from ns3::PositionAllocator
 PositionAllocator ()
 
virtual ~PositionAllocator ()
 
virtual int64_t AssignStreams (int64_t stream)=0
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual Vector GetNext (void) const =0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::PositionAllocator
static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Ptr< RandomVariableStreamm_rho
 pointer to rho's random variable stream More...
 
Ptr< RandomVariableStreamm_theta
 pointer to theta's random variable stream More...
 
double m_x
 x coordinate of center of disc More...
 
double m_y
 y coordinate of center of disc More...
 
double m_z
 z coordinate of the disc More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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

  • Theta: A random variable which represents the angle (gradients) of a position in a random disc.
  • Rho: A random variable which represents the radius of a position in a random disc.
  • 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 72 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ RandomDiscPositionAllocator()

ns3::RandomDiscPositionAllocator::RandomDiscPositionAllocator ( )

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

◆ ~RandomDiscPositionAllocator()

ns3::RandomDiscPositionAllocator::~RandomDiscPositionAllocator ( )
virtual

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

Member Function Documentation

◆ AssignStreams()

int64_t ns3::RandomDiscPositionAllocator::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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

Definition at line 520 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 ( void  ) const
virtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

Definition at line 509 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 ( void  )
static

Register this type with the TypeId system.

Returns
the object TypeId

Definition at line 437 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
rhoRandom variable that represents the radius of a position, in meters, in a random disc.

Definition at line 485 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
thetaRandom variable that represents the angle in radians of a position in a random disc.

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

References m_theta.

◆ SetX()

void ns3::RandomDiscPositionAllocator::SetX ( double  x)
Parameters
xthe X coordinate of the center of the disc

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

References m_x.

◆ SetY()

void ns3::RandomDiscPositionAllocator::SetY ( double  y)
Parameters
ythe Y coordinate of the center of the disc

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

References m_y.

◆ SetZ()

void ns3::RandomDiscPositionAllocator::SetZ ( double  z)
Parameters
zthe Z coordinate of all the positions allocated

Definition at line 503 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 356 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 355 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 357 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 358 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 359 of file position-allocator.h.

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


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