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

Allocate random positions within a 3D box according to a set of three random variables. More...

#include "position-allocator.h"

+ Inheritance diagram for ns3::RandomBoxPositionAllocator:
+ Collaboration diagram for ns3::RandomBoxPositionAllocator:

Public Member Functions

 RandomBoxPositionAllocator ()
 
virtual ~RandomBoxPositionAllocator ()
 
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)
 Set the random variable stream object that generates x-positions. More...
 
void SetY (Ptr< RandomVariableStream > y)
 Set the random variable stream object that generates y-positions. More...
 
void SetZ (Ptr< RandomVariableStream > z)
 Set the random variable stream object that generates z-positions. More...
 
- 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_x
 pointer to x's random variable stream More...
 
Ptr< RandomVariableStreamm_y
 pointer to y's random variable stream More...
 
Ptr< RandomVariableStreamm_z
 pointer to z's random variable stream 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 3D box according to a set of three random variables.

Config Paths

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

  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator"

Attributes

No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ RandomBoxPositionAllocator()

ns3::RandomBoxPositionAllocator::RandomBoxPositionAllocator ( )

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

◆ ~RandomBoxPositionAllocator()

ns3::RandomBoxPositionAllocator::~RandomBoxPositionAllocator ( )
virtual

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

Member Function Documentation

◆ AssignStreams()

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

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

+ Here is the call graph for this function:

◆ GetNext()

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

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References ns3::RandomVariableStream::GetValue(), m_x, m_y, and m_z.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Register this type with the TypeId system.

Returns
the object TypeId

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

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

+ Here is the call graph for this function:

◆ SetX()

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

Set the random variable stream object that generates x-positions.

Parameters
xpointer to a RandomVariableStream object

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

References m_x.

◆ SetY()

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

Set the random variable stream object that generates y-positions.

Parameters
ypointer to a RandomVariableStream object

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

References m_y.

◆ SetZ()

void ns3::RandomBoxPositionAllocator::SetZ ( Ptr< RandomVariableStream z)

Set the random variable stream object that generates z-positions.

Parameters
zpointer to a RandomVariableStream object

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

References m_z.

Member Data Documentation

◆ m_x

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

pointer to x's random variable stream

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

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

◆ m_y

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

pointer to y's random variable stream

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

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

◆ m_z

Ptr<RandomVariableStream> ns3::RandomBoxPositionAllocator::m_z
private

pointer to z's random variable stream

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

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


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