ns3::RandomWalk2dMobilityModel Class Reference

a 2D random walk position model More...

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

Inheritance diagram for ns3::RandomWalk2dMobilityModel:

Inheritance graph
[legend]
Collaboration diagram for ns3::RandomWalk2dMobilityModel:

Collaboration graph
[legend]

List of all members.

Static Public Member Functions

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

Private Member Functions

virtual void DoDispose (void)
virtual Vector DoGetPosition (void) const
virtual void DoSetPosition (const Vector &position)
virtual Vector DoGetVelocity (void) const

Detailed Description

a 2D random walk position 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.

Member Function Documentation

virtual void ns3::RandomWalk2dMobilityModel::DoDispose ( void   )  [private, virtual]

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.

Reimplemented from ns3::Object.

virtual Vector ns3::RandomWalk2dMobilityModel::DoGetPosition ( void   )  const [private, virtual]

Returns:
the current position.
Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

virtual Vector ns3::RandomWalk2dMobilityModel::DoGetVelocity ( void   )  const [private, virtual]

Returns:
the current velocity.
Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

virtual void ns3::RandomWalk2dMobilityModel::DoSetPosition ( const Vector &  position  )  [private, virtual]

Parameters:
position the position to set.
Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

static 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.
  • Time: Change current direction and speed after moving for this delay.
    • Set with class: TimeValue
    • Underlying type: Time
    • Initial value: 1000000000ns
    • 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).
  • Speed: A random variable used to pick the speed (m/s).
Attributes defined in parent class ns3::MobilityModel:
  • Position: The current position of the mobility model.
  • Velocity: The current velocity of the mobility model.
No TraceSources defined for this type.
TraceSources defined in parent class ns3::MobilityModel:
  • CourseChange: The value of the position and/or velocity vector changed

Reimplemented from ns3::MobilityModel.

The documentation for this class was generated from the following files:
Generated on Fri Apr 9 15:01:10 2010 for NS-3 by  doxygen 1.5.8