A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::RandomRectanglePositionAllocator Class Reference

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)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
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)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 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. 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
 
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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Ptr< RandomVariableStreamm_x
 
Ptr< RandomVariableStreamm_y
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

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

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

ns3::RandomRectanglePositionAllocator::~RandomRectanglePositionAllocator ( )
virtual

Definition at line 245 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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

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

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

+ Here is the call graph for this function:

Vector ns3::RandomRectanglePositionAllocator::GetNext ( void  ) const
virtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

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

+ Here is the call graph for this function:

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

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

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

+ Here is the call graph for this function:

void ns3::RandomRectanglePositionAllocator::SetX ( Ptr< RandomVariableStream x)

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

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

void ns3::RandomRectanglePositionAllocator::SetY ( Ptr< RandomVariableStream y)

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

References m_y.

Member Data Documentation

Ptr<RandomVariableStream> ns3::RandomRectanglePositionAllocator::m_x
private

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

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

Ptr<RandomVariableStream> ns3::RandomRectanglePositionAllocator::m_y
private

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

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


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