A Discrete-Event Network Simulator
API
ns3::RandomWaypointMobilityModel Class Reference

Random waypoint mobility model. More...

#include "random-waypoint-mobility-model.h"

+ Inheritance diagram for ns3::RandomWaypointMobilityModel:
+ Collaboration diagram for ns3::RandomWaypointMobilityModel:

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::MobilityModel
static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoInitialize (void)
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::MobilityModel
void NotifyCourseChange (void) const
 Must be invoked by subclasses when the course of the position changes to notify course change listeners. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Member Functions

void BeginWalk (void)
 Get next position, begin moving towards it, schedule future pause event. More...
 
virtual int64_t DoAssignStreams (int64_t)
 The default implementation does nothing but return the passed-in parameter. More...
 
virtual Vector DoGetPosition (void) const
 
virtual Vector DoGetVelocity (void) const
 
void DoInitializePrivate (void)
 Begin current pause event, schedule future walk event. More...
 
virtual void DoSetPosition (const Vector &position)
 

Private Attributes

EventId m_event
 event ID of next scheduled event More...
 
ConstantVelocityHelper m_helper
 helper for velocity computations More...
 
Ptr< RandomVariableStreamm_pause
 random variable to generate pauses More...
 
Ptr< PositionAllocatorm_position
 pointer to position allocator More...
 
Ptr< RandomVariableStreamm_speed
 random variable to generate speeds More...
 

Additional Inherited Members

- Public Types inherited from ns3::MobilityModel
typedef void(* TracedCallback) (Ptr< const MobilityModel > model)
 TracedCallback signature. More...
 
- Public Member Functions inherited from ns3::MobilityModel
 MobilityModel ()
 
virtual ~MobilityModel ()=0
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
double GetDistanceFrom (Ptr< const MobilityModel > position) const
 
Vector GetPosition (void) const
 
double GetRelativeSpeed (Ptr< const MobilityModel > other) const
 
Vector GetVelocity (void) const
 
void SetPosition (const Vector &position)
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. 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...
 

Detailed Description

Random waypoint mobility model.

Each object starts by pausing at time zero for the duration governed by the random variable "Pause". After pausing, the object will pick a new waypoint (via the PositionAllocator) and a new random speed via the random variable "Speed", and will begin moving towards the waypoint at a constant speed. When it reaches the destination, the process starts over (by pausing).

This mobility model enforces no bounding box by itself; the PositionAllocator assigned to this object will bound the movement. If the user fails to provide a pointer to a PositionAllocator to be used to pick waypoints, the simulation program will assert.

The implementation of this model is not 2d-specific. i.e. if you provide a 3d random waypoint position model to this mobility model, the model will still work. There is no 3d position allocator for now but it should be trivial to add one.

Config Paths

ns3::RandomWaypointMobilityModel is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes

Attributes defined in parent class ns3::MobilityModel

  • Position: The current position of the mobility model.
  • Velocity: The current velocity of the mobility model.

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::MobilityModel

Size of this type is 168 bytes (on a 64-bit architecture).

Definition at line 52 of file random-waypoint-mobility-model.h.

Member Function Documentation

void ns3::RandomWaypointMobilityModel::BeginWalk ( void  )
private
int64_t ns3::RandomWaypointMobilityModel::DoAssignStreams ( int64_t  start)
privatevirtual

The default implementation does nothing but return the passed-in parameter.

Subclasses using random variables are expected to override this.

Parameters
startstarting stream index
Returns
the number of streams used

Reimplemented from ns3::MobilityModel.

Definition at line 116 of file random-waypoint-mobility-model.cc.

References m_pause, m_position, m_speed, NS_ASSERT_MSG(), and ns3::RandomVariableStream::SetStream().

+ Here is the call graph for this function:

Vector ns3::RandomWaypointMobilityModel::DoGetPosition ( void  ) const
privatevirtual
Returns
the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 98 of file random-waypoint-mobility-model.cc.

References ns3::ConstantVelocityHelper::GetCurrentPosition(), m_helper, and ns3::ConstantVelocityHelper::Update().

+ Here is the call graph for this function:

Vector ns3::RandomWaypointMobilityModel::DoGetVelocity ( void  ) const
privatevirtual
Returns
the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 111 of file random-waypoint-mobility-model.cc.

References ns3::ConstantVelocityHelper::GetVelocity(), and m_helper.

+ Here is the call graph for this function:

void ns3::RandomWaypointMobilityModel::DoInitialize ( void  )
protectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 81 of file random-waypoint-mobility-model.cc.

References ns3::Object::DoInitialize(), and DoInitializePrivate().

+ Here is the call graph for this function:

void ns3::RandomWaypointMobilityModel::DoInitializePrivate ( void  )
private

Begin current pause event, schedule future walk event.

Definition at line 88 of file random-waypoint-mobility-model.cc.

References BeginWalk(), ns3::RandomVariableStream::GetValue(), m_event, m_helper, m_pause, ns3::MobilityModel::NotifyCourseChange(), ns3::ConstantVelocityHelper::Pause(), ns3::Simulator::Schedule(), ns3::Seconds(), and ns3::ConstantVelocityHelper::Update().

Referenced by BeginWalk(), DoInitialize(), and DoSetPosition().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::RandomWaypointMobilityModel::DoSetPosition ( const Vector &  position)
privatevirtual
Parameters
positionthe position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 104 of file random-waypoint-mobility-model.cc.

References DoInitializePrivate(), m_event, m_helper, ns3::Simulator::Remove(), ns3::Simulator::ScheduleNow(), and ns3::ConstantVelocityHelper::SetPosition().

+ Here is the call graph for this function:

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

Register this type with the TypeId system.

Returns
the object TypeId

Definition at line 33 of file random-waypoint-mobility-model.cc.

References m_pause, m_position, m_speed, ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

EventId ns3::RandomWaypointMobilityModel::m_event
private

event ID of next scheduled event

Definition at line 80 of file random-waypoint-mobility-model.h.

Referenced by BeginWalk(), DoInitializePrivate(), and DoSetPosition().

ConstantVelocityHelper ns3::RandomWaypointMobilityModel::m_helper
private

helper for velocity computations

Definition at line 76 of file random-waypoint-mobility-model.h.

Referenced by BeginWalk(), DoGetPosition(), DoGetVelocity(), DoInitializePrivate(), and DoSetPosition().

Ptr<RandomVariableStream> ns3::RandomWaypointMobilityModel::m_pause
private

random variable to generate pauses

Definition at line 79 of file random-waypoint-mobility-model.h.

Referenced by DoAssignStreams(), DoInitializePrivate(), and GetTypeId().

Ptr<PositionAllocator> ns3::RandomWaypointMobilityModel::m_position
private

pointer to position allocator

Definition at line 77 of file random-waypoint-mobility-model.h.

Referenced by BeginWalk(), DoAssignStreams(), and GetTypeId().

Ptr<RandomVariableStream> ns3::RandomWaypointMobilityModel::m_speed
private

random variable to generate speeds

Definition at line 78 of file random-waypoint-mobility-model.h.

Referenced by BeginWalk(), DoAssignStreams(), and GetTypeId().


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