A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
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)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual Vector GetNext (void) const
 
- 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...
 
SimpleRefCount & operator= (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< Building > bptr
 
uint32_t floor
 
Ptr< UniformRandomVariable > m_rand
 Provides uniform random variables. More...
 
uint32_t roomx
 
uint32_t roomy
 

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

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.

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

Constructor & Destructor Documentation

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

References bptr, floor, m_rand, roomx, roomy, and sample-rng-plot::x.

Member Function Documentation

int64_t ns3::FixedRoomPositionAllocator::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 346 of file building-position-allocator.cc.

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

+ Here is the call graph for this function:

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

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References bptr, floor, ns3::UniformRandomVariable::GetValue(), m_rand, NS_LOG_LOGIC, roomx, roomy, and sample-rng-plot::x.

+ Here is the call graph for this function:

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

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

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

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

uint32_t ns3::FixedRoomPositionAllocator::floor
private

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

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

Provides uniform random variables.

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

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

uint32_t ns3::FixedRoomPositionAllocator::roomx
private

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

uint32_t ns3::FixedRoomPositionAllocator::roomy
private

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

Referenced by FixedRoomPositionAllocator(), and GetNext().

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