Generate a random position uniformly distributed in the volume of a chosen room inside a chosen building. More...
#include "building-position-allocator.h"
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 () | |
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< Object > | GetObject () 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< Object > | GetObject (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[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= ([[maybe_unused]] 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... | |
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 | |
Ptr< Building > | bptr |
Pointer to the chosen building. More... | |
uint32_t | floor |
Index of the room on the z-axis (i.e., floor number) More... | |
Ptr< UniformRandomVariable > | m_rand |
Provides uniform random variables. More... | |
uint32_t | roomx |
Index of the room on the x-axis. More... | |
uint32_t | roomy |
Index of the room on the y-axis. 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... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Generate a random position uniformly distributed in the volume of a chosen room inside a chosen building.
ns3::FixedRoomPositionAllocator is accessible through the following paths with Config::Set and Config::Connect:
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 232 of file building-position-allocator.h.
ns3::FixedRoomPositionAllocator::FixedRoomPositionAllocator | ( | uint32_t | x, |
uint32_t | y, | ||
uint32_t | z, | ||
Ptr< Building > | b | ||
) |
x | index of the room on the x-axis |
y | index of the room on the y-axis |
z | index of the room on the z-axis (i.e., floor number) |
b | pointer to the chosen building |
Definition at line 406 of file building-position-allocator.cc.
References bptr, floor, m_rand, roomx, roomy, and sample-rng-plot::x.
|
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.
stream | first stream index to use |
Implements ns3::PositionAllocator.
Definition at line 460 of file building-position-allocator.cc.
References m_rand, and ns3::RandomVariableStream::SetStream().
|
virtual |
This method must be implement in subclasses.
Implements ns3::PositionAllocator.
Definition at line 430 of file building-position-allocator.cc.
References bptr, floor, ns3::UniformRandomVariable::GetValue(), m_rand, NS_LOG_LOGIC, roomx, roomy, sample-rng-plot::x, ns3::Box::xMax, ns3::Box::xMin, ns3::Box::yMax, ns3::Box::yMin, ns3::Box::zMax, and ns3::Box::zMin.
|
static |
Get the type ID.
Definition at line 420 of file building-position-allocator.cc.
References ns3::TypeId::SetParent().
Pointer to the chosen building.
Definition at line 273 of file building-position-allocator.h.
Referenced by FixedRoomPositionAllocator(), and GetNext().
|
private |
Index of the room on the z-axis (i.e., floor number)
Definition at line 271 of file building-position-allocator.h.
Referenced by FixedRoomPositionAllocator(), and GetNext().
|
private |
Provides uniform random variables.
Definition at line 276 of file building-position-allocator.h.
Referenced by FixedRoomPositionAllocator(), AssignStreams(), and GetNext().
|
private |
Index of the room on the x-axis.
Definition at line 269 of file building-position-allocator.h.
Referenced by FixedRoomPositionAllocator(), and GetNext().
|
private |
Index of the room on the y-axis.
Definition at line 270 of file building-position-allocator.h.
Referenced by FixedRoomPositionAllocator(), and GetNext().