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

allocate outdoor positions More...

#include "building-position-allocator.h"

+ Inheritance diagram for ns3::OutdoorPositionAllocator:
+ Collaboration diagram for ns3::OutdoorPositionAllocator:

Public Member Functions

 OutdoorPositionAllocator ()
 
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)
 Get the type ID. 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

uint32_t m_maxAttempts
 maximum number of attempts before giving up More...
 
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 outdoor positions

Allocate positions outside of existing buildings using rejection sampling. This class extracts a random position in a box defined by the three RandomVariableStreams for the X, Y and Z dimensions (similarly to RandomBoxPositionAllocator), until a position is found that is outdoors with respect to all of the buildings in the scenario, or a maximum number of attempts is reached. The RandomVariableStream and the maximum number of attempts can be set using attributes. If the maximum number of attempts is reached, then the simulation aborts due to failure of properly positioning the node.

Config Paths

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

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

Attributes

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

Definition at line 86 of file building-position-allocator.h.

Constructor & Destructor Documentation

◆ OutdoorPositionAllocator()

ns3::OutdoorPositionAllocator::OutdoorPositionAllocator ( )

Definition at line 112 of file building-position-allocator.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::OutdoorPositionAllocator::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.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

Definition at line 216 of file building-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::OutdoorPositionAllocator::GetNext ( void  ) const
virtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

Definition at line 165 of file building-position-allocator.cc.

References ns3::BuildingList::Begin(), ns3::BuildingList::End(), ns3::BuildingList::GetNBuildings(), ns3::RandomVariableStream::GetValue(), m_maxAttempts, m_x, m_y, m_z, NS_ABORT_MSG_IF, and NS_LOG_INFO.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
The object TypeId.

Definition at line 117 of file building-position-allocator.cc.

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

+ Here is the call graph for this function:

◆ SetX()

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

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

Parameters
xpointer to a RandomVariableStream object

Definition at line 149 of file building-position-allocator.cc.

References m_x.

◆ SetY()

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

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

Parameters
ypointer to a RandomVariableStream object

Definition at line 154 of file building-position-allocator.cc.

References m_y.

◆ SetZ()

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

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

Parameters
zpointer to a RandomVariableStream object

Definition at line 159 of file building-position-allocator.cc.

References m_z.

Member Data Documentation

◆ m_maxAttempts

uint32_t ns3::OutdoorPositionAllocator::m_maxAttempts
private

maximum number of attempts before giving up

Definition at line 131 of file building-position-allocator.h.

Referenced by GetNext(), and GetTypeId().

◆ m_x

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

pointer to x's random variable stream

Definition at line 127 of file building-position-allocator.h.

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

◆ m_y

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

pointer to y's random variable stream

Definition at line 128 of file building-position-allocator.h.

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

◆ m_z

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

pointer to z's random variable stream

Definition at line 129 of file building-position-allocator.h.

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


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