|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
allocate outdoor positions More...
#include "building-position-allocator.h"
Inheritance diagram for ns3::OutdoorPositionAllocator: Collaboration diagram for ns3::OutdoorPositionAllocator:Public Member Functions | |
| OutdoorPositionAllocator () | |
| int64_t | AssignStreams (int64_t stream) override |
| Assign a fixed random variable stream number to the random variables used by this model. More... | |
| Vector | GetNext () const override |
| void | SetX (Ptr< RandomVariableStream > x) |
| Set the random variable stream object that generates x-positions. More... | |
| void | SetY (Ptr< RandomVariableStream > y) |
| Set the random variable stream object that generates y-positions. More... | |
| void | SetZ (Ptr< RandomVariableStream > z) |
| Set the random variable stream object that generates z-positions. More... | |
| Public Member Functions inherited from ns3::PositionAllocator | |
| PositionAllocator () | |
| ~PositionAllocator () override | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| Constructor. More... | |
| ~Object () override | |
| Destructor. More... | |
| void | AggregateObject (Ptr< Object > other) |
| Aggregate two Objects together. More... | |
| void | Dispose () |
| Dispose of this Object. More... | |
| AggregateIterator | GetAggregateIterator () const |
| Get an iterator to the Objects aggregated to this one. More... | |
| TypeId | GetInstanceTypeId () const override |
| Get the most derived TypeId for this Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject () const |
| Get a pointer to the requested aggregated 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... | |
| void | Initialize () |
| Invoke DoInitialize on all Objects aggregated to this one. More... | |
| bool | IsInitialized () 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 () const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
| Assignment operator. More... | |
| void | Ref () const |
| Increment the reference count. More... | |
| void | Unref () 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 errors. 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 () |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::PositionAllocator | |
| static TypeId | GetTypeId () |
| Register this type with the TypeId system. More... | |
| Static Public Member Functions inherited from ns3::Object | |
| static TypeId | GetTypeId () |
| Register this type. More... | |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId () |
| Get the type ID. More... | |
Private Attributes | |
| uint32_t | m_maxAttempts |
| maximum number of attempts before giving up More... | |
| Ptr< RandomVariableStream > | m_x |
| pointer to x's random variable stream More... | |
| Ptr< RandomVariableStream > | m_y |
| pointer to y's random variable stream More... | |
| Ptr< RandomVariableStream > | m_z |
| pointer to z's random variable stream More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. More... | |
| virtual void | DoDispose () |
| Destructor implementation. More... | |
| virtual void | DoInitialize () |
| Initialize() implementation. More... | |
| virtual void | NotifyNewAggregate () |
| 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 () |
| Notifier called once the ObjectBase is fully constructed. More... | |
| Related Functions inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid () |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
allocate outdoor positions
Allocate positions outside of existing buildings using rejection sampling. This class extracts a random position in a box defined by the three RandomVariableStreams for the X, Y and Z dimensions (similarly to RandomBoxPositionAllocator), until a position is found that is outdoors with respect to all of the buildings in the scenario, or a maximum number of attempts is reached. The RandomVariableStream and the maximum number of attempts can be set using attributes. If the maximum number of attempts is reached, then the simulation aborts due to failure of properly positioning the node.
Definition at line 85 of file building-position-allocator.h.
| ns3::OutdoorPositionAllocator::OutdoorPositionAllocator | ( | ) |
Definition at line 113 of file building-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.
| stream | first stream index to use |
Implements ns3::PositionAllocator.
Definition at line 224 of file building-position-allocator.cc.
References m_x, m_y, m_z, and ns3::RandomVariableStream::SetStream().
Here is the call graph for this function:
|
overridevirtual |
This method must be implement in subclasses.
Implements ns3::PositionAllocator.
Definition at line 171 of file building-position-allocator.cc.
References ns3::BuildingList::Begin(), ns3::BuildingList::End(), ns3::BuildingList::GetNBuildings(), ns3::RandomVariableStream::GetValue(), m_maxAttempts, m_x, m_y, m_z, NS_ABORT_MSG_IF, NS_LOG_INFO, and two-ray-to-three-gpp-ch-calibration::x.
Here is the call graph for this function:
|
static |
Get the type ID.
Definition at line 118 of file building-position-allocator.cc.
References m_maxAttempts, m_x, m_y, m_z, ns3::MakePointerAccessor(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:| void ns3::OutdoorPositionAllocator::SetX | ( | Ptr< RandomVariableStream > | x | ) |
Set the random variable stream object that generates x-positions.
| x | pointer to a RandomVariableStream object |
Definition at line 153 of file building-position-allocator.cc.
References m_x, and two-ray-to-three-gpp-ch-calibration::x.
| void ns3::OutdoorPositionAllocator::SetY | ( | Ptr< RandomVariableStream > | y | ) |
Set the random variable stream object that generates y-positions.
| y | pointer to a RandomVariableStream object |
Definition at line 159 of file building-position-allocator.cc.
References m_y.
| void ns3::OutdoorPositionAllocator::SetZ | ( | Ptr< RandomVariableStream > | z | ) |
Set the random variable stream object that generates z-positions.
| z | pointer to a RandomVariableStream object |
Definition at line 165 of file building-position-allocator.cc.
References m_z.
|
private |
maximum number of attempts before giving up
Definition at line 130 of file building-position-allocator.h.
Referenced by GetNext(), and GetTypeId().
|
private |
pointer to x's random variable stream
Definition at line 126 of file building-position-allocator.h.
Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetX().
|
private |
pointer to y's random variable stream
Definition at line 127 of file building-position-allocator.h.
Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetY().
|
private |
pointer to z's random variable stream
Definition at line 128 of file building-position-allocator.h.
Referenced by AssignStreams(), GetNext(), GetTypeId(), and SetZ().
1.9.1 
