A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 
virtual Vector GetNext (void) const
 
void SetRho (Ptr< RandomVariableStream > rho)
 
void SetTheta (Ptr< RandomVariableStream > theta)
 
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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (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< RandomVariableStreamm_rho
 
Ptr< RandomVariableStreamm_theta
 
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 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 disc according to a given distribution for the polar coordinates of each node with respect to the provided center of the disc.

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

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::RandomDiscPositionAllocator::RandomDiscPositionAllocator ( )

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

ns3::RandomDiscPositionAllocator::~RandomDiscPositionAllocator ( )
virtual

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

Member Function Documentation

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 412 of file position-allocator.cc.

References m_rho, m_theta, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

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 401 of file position-allocator.cc.

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

+ Here is the call graph for this function:

TypeId ns3::RandomDiscPositionAllocator::GetTypeId ( void  )
static

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

References m_rho, m_theta, m_x, m_y, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::RandomDiscPositionAllocator::SetRho ( Ptr< RandomVariableStream rho)

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

References m_rho.

void ns3::RandomDiscPositionAllocator::SetTheta ( Ptr< RandomVariableStream theta)

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

References m_theta.

void ns3::RandomDiscPositionAllocator::SetX ( double  x)

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

References m_x, and sample-rng-plot::x.

void ns3::RandomDiscPositionAllocator::SetY ( double  y)

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

References m_y.

Member Data Documentation

Ptr<RandomVariableStream> ns3::RandomDiscPositionAllocator::m_rho
private

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

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

Ptr<RandomVariableStream> ns3::RandomDiscPositionAllocator::m_theta
private

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

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

double ns3::RandomDiscPositionAllocator::m_x
private

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

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

double ns3::RandomDiscPositionAllocator::m_y
private

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

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


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