A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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:

Public Member Functions

 ~RandomWaypointMobilityModel () override
 
- Public Member Functions inherited from ns3::MobilityModel
 MobilityModel ()
 
 ~MobilityModel () override=0
 
int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model.
 
double GetDistanceFrom (Ptr< const MobilityModel > position) const
 
Vector GetPosition () const
 
Vector GetPositionWithReference (const Vector &referencePosition) const
 This method may be used if the position returned may depend on some reference position provided.
 
double GetRelativeSpeed (Ptr< const MobilityModel > other) const
 
Vector GetVelocity () const
 
void SetPosition (const Vector &position)
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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::MobilityModel
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.
 

Protected Member Functions

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

Private Member Functions

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

Private Attributes

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

Additional Inherited Members

- Public Types inherited from ns3::MobilityModel
typedef void(* TracedCallback) (Ptr< const MobilityModel > model)
 TracedCallback signature.
 

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.

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

Constructor & Destructor Documentation

◆ ~RandomWaypointMobilityModel()

ns3::RandomWaypointMobilityModel::~RandomWaypointMobilityModel ( )
override

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

References ns3::EventId::Cancel(), and m_event.

+ Here is the call graph for this function:

Member Function Documentation

◆ BeginWalk()

void ns3::RandomWaypointMobilityModel::BeginWalk ( )
private

Get next position, begin moving towards it, schedule future pause event.

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

References ns3::EventId::Cancel(), DoInitializePrivate(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::RandomVariableStream::GetValue(), m_event, m_helper, m_position, m_speed, ns3::MobilityModel::NotifyCourseChange(), NS_ASSERT_MSG, ns3::Simulator::Schedule(), ns3::Seconds(), ns3::ConstantVelocityHelper::SetVelocity(), ns3::ConstantVelocityHelper::Unpause(), and ns3::ConstantVelocityHelper::Update().

Referenced by DoInitializePrivate().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoAssignStreams()

int64_t ns3::RandomWaypointMobilityModel::DoAssignStreams ( int64_t start)
overrideprivatevirtual

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 121 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:

◆ DoGetPosition()

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

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 100 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:

◆ DoGetVelocity()

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

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

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

+ Here is the call graph for this function:

◆ DoInitialize()

void ns3::RandomWaypointMobilityModel::DoInitialize ( )
overrideprotectedvirtual

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 83 of file random-waypoint-mobility-model.cc.

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

+ Here is the call graph for this function:

◆ DoInitializePrivate()

void ns3::RandomWaypointMobilityModel::DoInitializePrivate ( )
private

Begin current pause event, schedule future walk event.

Definition at line 90 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:

◆ DoSetPosition()

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

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

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

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::RandomWaypointMobilityModel::GetTypeId ( )
static

Register this type with the TypeId system.

Returns
the object TypeId

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

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

+ Here is the call graph for this function:

Member Data Documentation

◆ m_event

EventId ns3::RandomWaypointMobilityModel::m_event
private

event ID of next scheduled event

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

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

◆ m_helper

ConstantVelocityHelper ns3::RandomWaypointMobilityModel::m_helper
private

helper for velocity computations

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

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

◆ m_pause

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

random variable to generate pauses

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

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

◆ m_position

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

pointer to position allocator

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

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

◆ m_speed

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

random variable to generate speeds

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

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


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