A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::FixedRoomPositionAllocator Class Reference

Generate a random position uniformly distributed in the volume of a chosen room inside a chosen building. More...

#include "building-position-allocator.h"

+ Inheritance diagram for ns3::FixedRoomPositionAllocator:
+ Collaboration diagram for ns3::FixedRoomPositionAllocator:

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

Ptr< Buildingbptr
 Pointer to the chosen building.
 
uint32_t floor
 Index of the room on the z-axis (i.e., floor number)
 
Ptr< UniformRandomVariablem_rand
 Provides uniform random variables.
 
uint32_t roomx
 Index of the room on the x-axis.
 
uint32_t roomy
 Index of the room on the y-axis.
 

Additional Inherited Members

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

Detailed Description

Generate a random position uniformly distributed in the volume of a chosen room inside a chosen building.

Config Paths

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

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

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

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

Constructor & Destructor Documentation

◆ FixedRoomPositionAllocator()

ns3::FixedRoomPositionAllocator::FixedRoomPositionAllocator ( uint32_t  x,
uint32_t  y,
uint32_t  z,
Ptr< Building b 
)
Parameters
xindex of the room on the x-axis
yindex of the room on the y-axis
zindex of the room on the z-axis (i.e., floor number)
bpointer to the chosen building

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

References bptr, floor, m_rand, roomx, and roomy.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::FixedRoomPositionAllocator::AssignStreams ( int64_t  stream)
overridevirtual

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

References m_rand, and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

◆ GetNext()

Vector ns3::FixedRoomPositionAllocator::GetNext ( ) const
overridevirtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References bptr, floor, ns3::UniformRandomVariable::GetValue(), m_rand, NS_LOG_LOGIC, roomx, roomy, ns3::Box::xMax, ns3::Box::xMin, ns3::Box::yMax, ns3::Box::yMin, ns3::Box::zMax, and ns3::Box::zMin.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::FixedRoomPositionAllocator::GetTypeId ( )
static

Get the type ID.

Returns
The object TypeId.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ bptr

Ptr<Building> ns3::FixedRoomPositionAllocator::bptr
private

Pointer to the chosen building.

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

◆ floor

uint32_t ns3::FixedRoomPositionAllocator::floor
private

Index of the room on the z-axis (i.e., floor number)

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

◆ m_rand

Ptr<UniformRandomVariable> ns3::FixedRoomPositionAllocator::m_rand
private

Provides uniform random variables.

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

Referenced by FixedRoomPositionAllocator(), AssignStreams(), and GetNext().

◆ roomx

uint32_t ns3::FixedRoomPositionAllocator::roomx
private

Index of the room on the x-axis.

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

◆ roomy

uint32_t ns3::FixedRoomPositionAllocator::roomy
private

Index of the room on the y-axis.

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

Referenced by FixedRoomPositionAllocator(), and GetNext().


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