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)
	This method returns the TypeId associated to ns3::RandomWaypointMobilityModel.

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

Private Member Functions
void	BeginWalk (void)
virtual int64_t	DoAssignStreams (int64_t)
virtual Vector	DoGetPosition (void) const
virtual Vector	DoGetVelocity (void) const
virtual void	DoSetPosition (const Vector &position)
void	DoStartPrivate (void)

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)
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)

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 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(), DoStartPrivate(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::PositionAllocator::GetNext(), 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(), ns3::ConstantVelocityHelper::Update(), ns3::Vector3D::x, ns3::Vector3D::y, and ns3::Vector3D::z.

Referenced by DoStartPrivate().

Here is the call graph for this function:

Here is the caller graph for this function:

int64_t ns3::RandomWaypointMobilityModel::DoAssignStreams ( int64_t stream )

privatevirtual

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

References ns3::PositionAllocator::AssignStreams(), 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

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

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::DoSetPosition ( const Vector & position )

privatevirtual

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

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

Here is the call graph for this function:

void ns3::RandomWaypointMobilityModel::DoStart ( void )

protectedvirtual

This method is called only once by Object::Start. If the user calls Object::Start multiple times, DoStart 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 DoStartPrivate().

Here is the call graph for this function:

void ns3::RandomWaypointMobilityModel::DoStartPrivate ( void )

private

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(), DoSetPosition(), and DoStart().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::RandomWaypointMobilityModel::GetTypeId ( void )

static

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

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

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

Attributes defined for this type:

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