2D random walk mobility model. More...

#include <random-walk-2d-mobility-model.h>

Inheritance diagram for ns3::RandomWalk2dMobilityModel:

Collaboration diagram for ns3::RandomWalk2dMobilityModel:

Public Types
enum	Mode { MODE_DISTANCE, MODE_TIME }

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::RandomWalk2dMobilityModel.

Private Member Functions
virtual int64_t	DoAssignStreams (int64_t)
virtual void	DoDispose (void)
virtual Vector	DoGetPosition (void) const
virtual Vector	DoGetVelocity (void) const
virtual void	DoSetPosition (const Vector &position)
virtual void	DoStart (void)
void	DoStartPrivate (void)
void	DoWalk (Time timeLeft)
void	Rebound (Time timeLeft)

Private Attributes
Rectangle	m_bounds
Ptr< RandomVariableStream >	m_direction
EventId	m_event
ConstantVelocityHelper	m_helper
enum Mode	m_mode
double	m_modeDistance
Time	m_modeTime
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)
Protected Member Functions inherited from ns3::MobilityModel
void	NotifyCourseChange (void) const

Detailed Description

2D random walk mobility model.

Each instance moves with a speed and direction choosen at random with the user-provided random variables until either a fixed distance has been walked or until a fixed amount of time. If we hit one of the boundaries (specified by a rectangle), of the model, we rebound on the boundary with a reflexive angle and speed. This model is often identified as a brownian motion model.

Definition at line 46 of file random-walk-2d-mobility-model.h.

Member Enumeration Documentation

enum ns3::RandomWalk2dMobilityModel::Mode

Enumerator:

MODE_DISTANCE
MODE_TIME

Definition at line 51 of file random-walk-2d-mobility-model.h.

Member Function Documentation

int64_t ns3::RandomWalk2dMobilityModel::DoAssignStreams ( int64_t stream )

privatevirtual

Definition at line 179 of file random-walk-2d-mobility-model.cc.

References m_direction, m_speed, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

void ns3::RandomWalk2dMobilityModel::DoDispose ( void )

privatevirtual

Definition at line 154 of file random-walk-2d-mobility-model.cc.

Vector ns3::RandomWalk2dMobilityModel::DoGetPosition ( void ) const

privatevirtual

Definition at line 160 of file random-walk-2d-mobility-model.cc.

References ns3::ConstantVelocityHelper::GetCurrentPosition(), m_bounds, m_helper, and ns3::ConstantVelocityHelper::UpdateWithBounds().

Here is the call graph for this function:

Vector ns3::RandomWalk2dMobilityModel::DoGetVelocity ( void ) const

privatevirtual

Definition at line 174 of file random-walk-2d-mobility-model.cc.

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

Here is the call graph for this function:

void ns3::RandomWalk2dMobilityModel::DoSetPosition ( const Vector & position )

privatevirtual

Definition at line 166 of file random-walk-2d-mobility-model.cc.

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

Here is the call graph for this function:

void ns3::RandomWalk2dMobilityModel::DoStart ( void )

privatevirtual

Definition at line 78 of file random-walk-2d-mobility-model.cc.

References DoStartPrivate().

Here is the call graph for this function:

void ns3::RandomWalk2dMobilityModel::DoStartPrivate ( void )

private

Definition at line 85 of file random-walk-2d-mobility-model.cc.

References DoWalk(), ns3::RandomVariableStream::GetValue(), m_direction, m_helper, m_mode, m_modeDistance, m_modeTime, m_speed, MODE_TIME, ns3::Seconds(), ns3::ConstantVelocityHelper::SetVelocity(), ns3::ConstantVelocityHelper::Unpause(), and ns3::ConstantVelocityHelper::Update().

Referenced by DoSetPosition(), DoStart(), and DoWalk().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RandomWalk2dMobilityModel::DoWalk ( Time timeLeft )

private

Definition at line 109 of file random-walk-2d-mobility-model.cc.

References ns3::Rectangle::CalculateIntersection(), ns3::EventId::Cancel(), DoStartPrivate(), ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::Time::GetSeconds(), ns3::ConstantVelocityHelper::GetVelocity(), ns3::Rectangle::IsInside(), m_bounds, m_event, m_helper, ns3::MobilityModel::NotifyCourseChange(), Rebound(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::Vector3D::x, and ns3::Vector3D::y.

Referenced by DoStartPrivate(), and Rebound().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::RandomWalk2dMobilityModel::GetTypeId ( void )

static

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

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

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

Attributes defined for this type:

Bounds: Bounds of the area to cruise.
- Set with class: RectangleValue
- Underlying type: Rectangle
- Initial value: 0|0|100|100
- Flags: construct write read
Time: Change current direction and speed after moving for this delay.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +1000000000.0ns
- Flags: construct write read
Distance: Change current direction and speed after moving for this distance.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
Mode: The mode indicates the condition used to change the current speed and direction
- Set with class: ns3::EnumValue
- Underlying type: Distance|Time
- Initial value: Distance
- Flags: construct write read
Direction: A random variable used to pick the direction (gradients).
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=6.283184]
- Flags: construct write read
Speed: A random variable used to pick the speed (m/s).
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::UniformRandomVariable[Min=2.0|Max=4.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