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)

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

Private Member Functions
virtual int64_t	DoAssignStreams (int64_t)
	The default implementation does nothing but return the passed-in parameter. More...

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

virtual Vector	DoGetPosition (void) const

virtual Vector	DoGetVelocity (void) const

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

void	DoInitializePrivate (void)

virtual void	DoSetPosition (const Vector &position)

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

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

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.

Config Paths

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

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

Attributes

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: ns3::TimeValue
- Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
- 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

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

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

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

References ns3::Object::DoDispose().

Here is the call graph for this function:

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

privatevirtual

Returns: the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 161 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

Returns: the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 175 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::DoInitialize ( void )

privatevirtual

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 79 of file random-walk-2d-mobility-model.cc.

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

Here is the call graph for this function: