A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
ns3::PositionAllocator Class Reference
Mobility

Allocate a set of positions. The allocation strategy is implemented in subclasses. More...

#include <position-allocator.h>

+ Inheritance diagram for ns3::PositionAllocator:
+ Collaboration diagram for ns3::PositionAllocator:

Public Member Functions

 PositionAllocator ()
virtual ~PositionAllocator ()
virtual int64_t AssignStreams (int64_t stream)=0
virtual Vector GetNext (void) const =0
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::PositionAllocator.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
virtual void DoDispose (void)
virtual void DoStart (void)
virtual void NotifyNewAggregate (void)

Detailed Description

Allocate a set of positions. The allocation strategy is implemented in subclasses.

This is a pure abstract base class.

Definition at line 35 of file position-allocator.h.

Constructor & Destructor Documentation

ns3::PositionAllocator::PositionAllocator ( )

Definition at line 43 of file position-allocator.cc.

ns3::PositionAllocator::~PositionAllocator ( )
virtual

Definition at line 47 of file position-allocator.cc.

Member Function Documentation

virtual int64_t ns3::PositionAllocator::AssignStreams ( int64_t  stream)
pure 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.

This method must be implement in subclasses.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implemented in ns3::UniformDiscPositionAllocator, ns3::RandomDiscPositionAllocator, ns3::RandomBoxPositionAllocator, ns3::RandomRectanglePositionAllocator, ns3::GridPositionAllocator, ns3::SameRoomPositionAllocator, ns3::RandomRoomPositionAllocator, ns3::ListPositionAllocator, and ns3::RandomBuildingPositionAllocator.

Referenced by ns3::RandomWaypointMobilityModel::DoAssignStreams().

+ Here is the caller graph for this function:

virtual Vector ns3::PositionAllocator::GetNext ( void  ) const
pure virtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implemented in ns3::UniformDiscPositionAllocator, ns3::RandomDiscPositionAllocator, ns3::RandomBoxPositionAllocator, ns3::RandomRectanglePositionAllocator, ns3::GridPositionAllocator, ns3::SameRoomPositionAllocator, ns3::RandomRoomPositionAllocator, ns3::ListPositionAllocator, and ns3::RandomBuildingPositionAllocator.

Referenced by ns3::RandomWaypointMobilityModel::BeginWalk(), and ns3::MobilityHelper::Install().

+ Here is the caller graph for this function:

TypeId ns3::PositionAllocator::GetTypeId ( void  )
static

This method returns the TypeId associated to ns3::PositionAllocator.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::UniformDiscPositionAllocator, ns3::RandomDiscPositionAllocator, ns3::RandomBoxPositionAllocator, ns3::RandomRectanglePositionAllocator, ns3::SameRoomPositionAllocator, ns3::GridPositionAllocator, ns3::RandomRoomPositionAllocator, ns3::ListPositionAllocator, and ns3::RandomBuildingPositionAllocator.

Definition at line 36 of file position-allocator.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: