Allocate random positions within a disc according to a given distribution for the polar coordinates of each node with respect to the provided center of the disc. More...
#include "position-allocator.h"
Public Member Functions | |
RandomDiscPositionAllocator () | |
~RandomDiscPositionAllocator () override | |
int64_t | AssignStreams (int64_t stream) override |
Assign a fixed random variable stream number to the random variables used by this model. | |
Vector | GetNext () const override |
void | SetRho (Ptr< RandomVariableStream > rho) |
Set the random variable that generates position radius, in meters. | |
void | SetTheta (Ptr< RandomVariableStream > theta) |
Set the random variable that generates position angle, in radians. | |
void | SetX (double x) |
void | SetY (double y) |
void | SetZ (double z) |
Public Member Functions inherited from ns3::PositionAllocator | |
PositionAllocator () | |
~PositionAllocator () override | |
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< Object > | GetObject () 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< Object > | GetObject (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. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
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. | |
SimpleRefCount & | operator= (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, bool permissive=false) 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. | |
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 () |
Register this type with the TypeId system. | |
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< RandomVariableStream > | m_rho |
pointer to rho's random variable stream | |
Ptr< RandomVariableStream > | m_theta |
pointer to theta's random variable stream | |
double | m_x |
x coordinate of center of disc | |
double | m_y |
y coordinate of center of disc | |
double | m_z |
z coordinate of the disc | |
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. | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Allocate random positions within a disc according to a given distribution for the polar coordinates of each node with respect to the provided center of the disc.
theta
and a uniform distribution for rho
this position allocator will not uniformly populate the disc. The radial distribution will be proportional to .To get a uniform distribution over a circle use the UniformDiscPositionAllocator.
Definition at line 303 of file position-allocator.h.
ns3::RandomDiscPositionAllocator::RandomDiscPositionAllocator | ( | ) |
Definition at line 478 of file position-allocator.cc.
|
override |
Definition at line 482 of file position-allocator.cc.
|
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.
This method must be implement in subclasses.
stream | first stream index to use |
Implements ns3::PositionAllocator.
Definition at line 528 of file position-allocator.cc.
References m_rho, m_theta, and ns3::RandomVariableStream::SetStream().
|
overridevirtual |
This method must be implement in subclasses.
Implements ns3::PositionAllocator.
Definition at line 517 of file position-allocator.cc.
References ns3::RandomVariableStream::GetValue(), m_rho, m_theta, m_x, m_y, m_z, and NS_LOG_DEBUG.
|
static |
Register this type with the TypeId system.
Definition at line 441 of file position-allocator.cc.
References m_rho, m_theta, m_x, m_y, m_z, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), and ns3::TypeId::SetParent().
void ns3::RandomDiscPositionAllocator::SetRho | ( | Ptr< RandomVariableStream > | rho | ) |
Set the random variable that generates position radius, in meters.
rho | Random variable that represents the radius of a position, in meters, in a random disc. |
Definition at line 493 of file position-allocator.cc.
References m_rho.
void ns3::RandomDiscPositionAllocator::SetTheta | ( | Ptr< RandomVariableStream > | theta | ) |
Set the random variable that generates position angle, in radians.
theta | Random variable that represents the angle in radians of a position in a random disc. |
Definition at line 487 of file position-allocator.cc.
References m_theta.
void ns3::RandomDiscPositionAllocator::SetX | ( | double | x | ) |
x | the X coordinate of the center of the disc |
Definition at line 499 of file position-allocator.cc.
References m_x.
void ns3::RandomDiscPositionAllocator::SetY | ( | double | y | ) |
y | the Y coordinate of the center of the disc |
Definition at line 505 of file position-allocator.cc.
References m_y.
void ns3::RandomDiscPositionAllocator::SetZ | ( | double | z | ) |
z | the Z coordinate of all the positions allocated |
Definition at line 511 of file position-allocator.cc.
References m_z.
|
private |
pointer to rho's random variable stream
Definition at line 344 of file position-allocator.h.
Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetRho().
|
private |
pointer to theta's random variable stream
Definition at line 343 of file position-allocator.h.
Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetTheta().
|
private |
x coordinate of center of disc
Definition at line 345 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetX().
|
private |
y coordinate of center of disc
Definition at line 346 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetY().
|
private |
z coordinate of the disc
Definition at line 347 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetZ().