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)

Static Public Member Functions inherited from ns3::MobilityModel
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. 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)
	This method is called only once by Object::Initialize. 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)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Private Member Functions
void	BeginWalk (void)

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)

virtual void	DoSetPosition (const Vector &position)

Private Attributes
EventId	m_event

ConstantVelocityHelper	m_helper

Ptr< RandomVariableStream >	m_pause

Ptr< PositionAllocator >	m_position

Ptr< RandomVariableStream >	m_speed

Additional Inherited Members
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 ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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)

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

Speed: A random variable used to pick the speed of a random waypoint model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::UniformRandomVariable[Min=0.3|Max=0.7]
- Flags: construct write read
Pause: A random variable used to pick the pause of a random waypoint model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::ConstantRandomVariable[Constant=2.0]
- Flags: construct write read
PositionAllocator: The position model used to pick a destination point.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::PositionAllocator>
- Initial value: 0
- Flags: construct write read

Attributes defined in parent class ns3::MobilityModel

Position: The current position of the mobility model.
- Set with class: Vector3DValue
- Underlying type: Vector3D
- Flags: write read
Velocity: The current velocity of the mobility model.
- Set with class: Vector3DValue
- Underlying type: Vector3D
- Flags: read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::MobilityModel

CourseChange: The value of the position and/or velocity vector changed

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

Member Function Documentation

void ns3::RandomWaypointMobilityModel::BeginWalk ( void )

private

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

References ns3::CalculateDistance(), 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::ConstantVelocityHelper::SetVelocity(), ns3::ConstantVelocityHelper::Unpause(), ns3::ConstantVelocityHelper::Update(), ns3::Vector3D::x, ns3::Vector3D::y, and ns3::Vector3D::z.

Referenced by DoInitializePrivate().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

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

This method is called only once by Object::Initialize.

If the user calls Object::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: