Allocate the positions uniformly (with constant density) randomly within a disc. More...
#include "position-allocator.h"
Public Member Functions | |
UniformDiscPositionAllocator () | |
~UniformDiscPositionAllocator () 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 (double rho) |
void | SetX (double x) |
void | SetY (double y) |
void | SetZ (double z) |
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< 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. | |
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) 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 () |
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 | |
double | m_rho |
value of the radius of the disc | |
Ptr< UniformRandomVariable > | m_rv |
pointer to uniform random variable | |
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 Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Allocate the positions uniformly (with constant density) randomly within a disc.
UniformDiscPositionAllocator allocates the positions randomly within a disc lying on the plane and having center at coordinates and radius . The random positions are chosen such that, for any subset , the expected value of the fraction of points which fall into corresponds to , i.e., to the ratio of the area of the subset to the area of the whole disc.
ns3::UniformDiscPositionAllocator is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 72 bytes (on a 64-bit architecture).
Definition at line 376 of file position-allocator.h.
ns3::UniformDiscPositionAllocator::UniformDiscPositionAllocator | ( | ) |
Definition at line 578 of file position-allocator.cc.
References m_rv.
|
override |
Definition at line 583 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 629 of file position-allocator.cc.
References m_rv, and ns3::RandomVariableStream::SetStream().
|
overridevirtual |
This method must be implement in subclasses.
Implements ns3::PositionAllocator.
Definition at line 612 of file position-allocator.cc.
References ns3::UniformRandomVariable::GetValue(), m_rho, m_rv, m_x, m_y, m_z, and NS_LOG_DEBUG.
|
static |
Register this type with the TypeId system.
Definition at line 549 of file position-allocator.cc.
References m_rho, m_x, m_y, m_z, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
void ns3::UniformDiscPositionAllocator::SetRho | ( | double | rho | ) |
rho | the value of the radius of the disc |
Definition at line 588 of file position-allocator.cc.
References m_rho.
void ns3::UniformDiscPositionAllocator::SetX | ( | double | x | ) |
x | the X coordinate of the center of the disc |
Definition at line 594 of file position-allocator.cc.
References m_x.
void ns3::UniformDiscPositionAllocator::SetY | ( | double | y | ) |
y | the Y coordinate of the center of the disc |
Definition at line 600 of file position-allocator.cc.
References m_y.
void ns3::UniformDiscPositionAllocator::SetZ | ( | double | z | ) |
z | the Z coordinate of all the positions allocated |
Definition at line 606 of file position-allocator.cc.
References m_z.
|
private |
value of the radius of the disc
Definition at line 412 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetRho().
|
private |
pointer to uniform random variable
Definition at line 411 of file position-allocator.h.
Referenced by UniformDiscPositionAllocator(), AssignStreams(), and GetNext().
|
private |
x coordinate of center of disc
Definition at line 413 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetX().
|
private |
y coordinate of center of disc
Definition at line 414 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetY().
|
private |
z coordinate of the disc
Definition at line 415 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetZ().