Allocate positions on a rectangular 2d grid. More...
#include "position-allocator.h"
Public Types | |
enum | LayoutType { ROW_FIRST , COLUMN_FIRST } |
Determine whether positions are allocated row first or column first. More... | |
Public Member Functions | |
GridPositionAllocator () | |
int64_t | AssignStreams (int64_t stream) override |
Assign a fixed random variable stream number to the random variables used by this model. | |
double | GetDeltaX () const |
double | GetDeltaY () const |
LayoutType | GetLayoutType () const |
double | GetMinX () const |
double | GetMinY () const |
uint32_t | GetN () const |
Vector | GetNext () const override |
void | SetDeltaX (double deltaX) |
void | SetDeltaY (double deltaY) |
void | SetLayoutType (LayoutType layoutType) |
void | SetMinX (double xMin) |
void | SetMinY (double yMin) |
void | SetN (uint32_t n) |
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 | |
uint32_t | m_current |
currently position | |
double | m_deltaX |
x interval between two consecutive x positions | |
double | m_deltaY |
y interval between two consecutive y positions | |
LayoutType | m_layoutType |
currently selected layout type | |
uint32_t | m_n |
number of positions to allocate on each row or column | |
double | m_xMin |
minimum boundary on x positions | |
double | m_yMin |
minimum boundary on y positions | |
double | m_z |
z coordinate of all the positions generated | |
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 positions on a rectangular 2d grid.
Definition at line 112 of file position-allocator.h.
Determine whether positions are allocated row first or column first.
Definition at line 124 of file position-allocator.h.
ns3::GridPositionAllocator::GridPositionAllocator | ( | ) |
Definition at line 182 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 286 of file position-allocator.cc.
double ns3::GridPositionAllocator::GetDeltaX | ( | ) | const |
Definition at line 242 of file position-allocator.cc.
References m_deltaX.
double ns3::GridPositionAllocator::GetDeltaY | ( | ) | const |
Definition at line 248 of file position-allocator.cc.
References m_deltaY.
GridPositionAllocator::LayoutType ns3::GridPositionAllocator::GetLayoutType | ( | ) | const |
Definition at line 260 of file position-allocator.cc.
References m_layoutType.
double ns3::GridPositionAllocator::GetMinX | ( | ) | const |
Definition at line 230 of file position-allocator.cc.
References m_xMin.
double ns3::GridPositionAllocator::GetMinY | ( | ) | const |
Definition at line 236 of file position-allocator.cc.
References m_yMin.
uint32_t ns3::GridPositionAllocator::GetN | ( | ) | const |
Definition at line 254 of file position-allocator.cc.
References m_n.
|
overridevirtual |
This method must be implement in subclasses.
Implements ns3::PositionAllocator.
Definition at line 266 of file position-allocator.cc.
References COLUMN_FIRST, m_current, m_deltaX, m_deltaY, m_layoutType, m_n, m_xMin, m_yMin, m_z, and ROW_FIRST.
|
static |
Register this type with the TypeId system.
Definition at line 137 of file position-allocator.cc.
References COLUMN_FIRST, m_deltaX, m_deltaY, m_layoutType, m_n, m_xMin, m_yMin, m_z, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ROW_FIRST, and ns3::TypeId::SetParent().
void ns3::GridPositionAllocator::SetDeltaX | ( | double | deltaX | ) |
deltaX | the x interval between two x-consecutive positions. |
Definition at line 206 of file position-allocator.cc.
References m_deltaX.
void ns3::GridPositionAllocator::SetDeltaY | ( | double | deltaY | ) |
deltaY | the y interval between two y-consecutive positions. |
Definition at line 212 of file position-allocator.cc.
References m_deltaY.
void ns3::GridPositionAllocator::SetLayoutType | ( | LayoutType | layoutType | ) |
layoutType | the type of layout to use (row first or column first). |
Definition at line 224 of file position-allocator.cc.
References m_layoutType.
void ns3::GridPositionAllocator::SetMinX | ( | double | xMin | ) |
xMin | the x coordinate where layout will start. |
Definition at line 188 of file position-allocator.cc.
References m_xMin.
void ns3::GridPositionAllocator::SetMinY | ( | double | yMin | ) |
yMin | the y coordinate where layout will start |
Definition at line 194 of file position-allocator.cc.
References m_yMin.
void ns3::GridPositionAllocator::SetN | ( | uint32_t | n | ) |
n | the number of positions allocated on each row (or each column) before switching to the next column (or row). |
Definition at line 218 of file position-allocator.cc.
References m_n.
void ns3::GridPositionAllocator::SetZ | ( | double | z | ) |
z | the Z coordinate of all the positions allocated |
Definition at line 200 of file position-allocator.cc.
References m_z.
|
mutableprivate |
|
private |
x interval between two consecutive x positions
Definition at line 207 of file position-allocator.h.
Referenced by GetDeltaX(), GetNext(), GetTypeId(), and SetDeltaX().
|
private |
y interval between two consecutive y positions
Definition at line 208 of file position-allocator.h.
Referenced by GetDeltaY(), GetNext(), GetTypeId(), and SetDeltaY().
|
private |
currently selected layout type
Definition at line 202 of file position-allocator.h.
Referenced by GetLayoutType(), GetNext(), GetTypeId(), and SetLayoutType().
|
private |
number of positions to allocate on each row or column
Definition at line 206 of file position-allocator.h.
Referenced by GetN(), GetNext(), GetTypeId(), and SetN().
|
private |
minimum boundary on x positions
Definition at line 203 of file position-allocator.h.
Referenced by GetMinX(), GetNext(), GetTypeId(), and SetMinX().
|
private |
minimum boundary on y positions
Definition at line 204 of file position-allocator.h.
Referenced by GetMinY(), GetNext(), GetTypeId(), and SetMinY().
|
private |
z coordinate of all the positions generated
Definition at line 205 of file position-allocator.h.
Referenced by GetNext(), GetTypeId(), and SetZ().