Gauss-Markov mobility model. More...

#include <gauss-markov-mobility-model.h>

Inheritance diagram for ns3::GaussMarkovMobilityModel:

Collaboration diagram for ns3::GaussMarkovMobilityModel:

Public Member Functions
	GaussMarkovMobilityModel ()
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)
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)

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

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)
void	DoWalk (Time timeLeft)
void	Start (void)

Private Attributes
double	m_alpha
Box	m_bounds
double	m_Direction
EventId	m_event
ConstantVelocityHelper	m_helper
double	m_meanDirection
double	m_meanPitch
double	m_meanVelocity
Ptr< NormalRandomVariable >	m_normalDirection
Ptr< NormalRandomVariable >	m_normalPitch
Ptr< NormalRandomVariable >	m_normalVelocity
double	m_Pitch
Ptr< RandomVariableStream >	m_rndMeanDirection
Ptr< RandomVariableStream >	m_rndMeanPitch
Ptr< RandomVariableStream >	m_rndMeanVelocity
Time	m_timeStep
double	m_Velocity

Additional Inherited Members
Protected Member Functions inherited from ns3::MobilityModel
void	NotifyCourseChange (void) const

Detailed Description

Gauss-Markov mobility model.

This is a 3D version of the Gauss-Markov mobility model described in [1]. Unlike the other mobility models in ns-3, which are memoryless, the Gauss Markov model has both memory and variability. The tunable alpha parameter determines the how much memory and randomness you want to model. Each object starts with a specific velocity, direction (radians), and pitch angle (radians) equivalent to the mean velocity, direction, and pitch. At each timestep, a new velocity, direction, and pitch angle are generated based upon the previous value, the mean value, and a gaussian random variable. This version is suited for simple airplane flight, where direction, velocity, and pitch are the key variables. The motion field is limited by a 3D bounding box (called "box") which is a 3D version of the "rectangle" field that is used in 2-dimensional ns-3 mobility models.

Here is an example of how to implement the model and set the initial node positions:

MobilityHelper mobility;
mobility.SetMobilityModel ("ns3::GaussMarkovMobilityModel",
  "Bounds", BoxValue (Box (0, 150000, 0, 150000, 0, 10000)),
  "TimeStep", TimeValue (Seconds (0.5)),
  "Alpha", DoubleValue (0.85),
  "MeanVelocity", StringValue ("ns3::UniformRandomVariable[Min=800|Max=1200]"),
  "MeanDirection", StringValue ("ns3::UniformRandomVariable[Min=0|Max=6.283185307]"),
  "MeanPitch", StringValue ("ns3::UniformRandomVariable[Min=0.05|Max=0.05]"),
  "NormalVelocity", StringValue ("ns3::NormalRandomVariable[Mean=0.0|Variance=0.0|Bound=0.0]"),
  "NormalDirection", StringValue ("ns3::NormalRandomVariable[Mean=0.0|Variance=0.2|Bound=0.4]"),
  "NormalPitch", StringValue ("ns3::NormalRandomVariable[Mean=0.0|Variance=0.02|Bound=0.04]"));
mobility.SetPositionAllocator ("ns3::RandomBoxPositionAllocator",
  "X", StringValue ("ns3::UniformRandomVariable[Min=0|Max=150000]"),
  "Y", StringValue ("ns3::UniformRandomVariable[Min=0|Max=150000]"),
  "Z", StringValue ("ns3::UniformRandomVariable[Min=0|Max=10000]"));
mobility.Install (wifiStaNodes);

[1] Tracy Camp, Jeff Boleng, Vanessa Davies, "A Survey of Mobility Models for Ad Hoc Network Research", Wireless Communications and Mobile Computing, Wiley, vol.2 iss.5, September 2002, pp.483-502

Definition at line 80 of file gauss-markov-mobility-model.h.

Constructor & Destructor Documentation

ns3::GaussMarkovMobilityModel::GaussMarkovMobilityModel ( )

Definition at line 88 of file gauss-markov-mobility-model.cc.

References m_event, m_helper, m_meanDirection, m_meanPitch, m_meanVelocity, ns3::Simulator::ScheduleNow(), Start(), and ns3::ConstantVelocityHelper::Unpause().

Here is the call graph for this function:

Member Function Documentation

int64_t ns3::GaussMarkovMobilityModel::DoAssignStreams ( int64_t stream )

privatevirtual

Definition at line 222 of file gauss-markov-mobility-model.cc.

References m_normalDirection, m_normalPitch, m_normalVelocity, m_rndMeanDirection, m_rndMeanPitch, m_rndMeanVelocity, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

void ns3::GaussMarkovMobilityModel::DoDispose ( void )

privatevirtual

Definition at line 196 of file gauss-markov-mobility-model.cc.

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

privatevirtual

Definition at line 203 of file gauss-markov-mobility-model.cc.

References ns3::ConstantVelocityHelper::GetCurrentPosition(), m_helper, and ns3::ConstantVelocityHelper::Update().

Here is the call graph for this function:

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

privatevirtual

Definition at line 216 of file gauss-markov-mobility-model.cc.

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

Here is the call graph for this function:

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

privatevirtual

Definition at line 209 of file gauss-markov-mobility-model.cc.

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

Here is the call graph for this function:

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

private

Definition at line 149 of file gauss-markov-mobility-model.cc.

References ns3::ConstantVelocityHelper::GetCurrentPosition(), ns3::Time::GetSeconds(), ns3::ConstantVelocityHelper::GetVelocity(), ns3::Box::IsInside(), m_bounds, m_Direction, m_event, m_helper, m_meanDirection, m_meanPitch, m_Pitch, ns3::MobilityModel::NotifyCourseChange(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::ConstantVelocityHelper::SetVelocity(), Start(), ns3::ConstantVelocityHelper::Unpause(), ns3::ConstantVelocityHelper::UpdateWithBounds(), ns3::Vector3D::x, ns3::Box::xMax, ns3::Box::xMin, ns3::Vector3D::y, ns3::Box::yMax, ns3::Box::yMin, ns3::Vector3D::z, ns3::Box::zMax, and ns3::Box::zMin.

Referenced by Start().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::GaussMarkovMobilityModel::GetTypeId ( void )

static

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

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

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

Attributes defined for this type:

Bounds: Bounds of the area to cruise.
- Set with class: BoxValue
- Underlying type: Box
- Initial value: -100|100|-100|100|0|100
- Flags: construct write read
TimeStep: Change current direction and speed after moving for this time.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +1000000000.0ns
- Flags: construct write read
Alpha: A constant representing the tunable parameter in the Gauss-Markov model.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 1
- Flags: construct write read
MeanVelocity: A random variable used to assign the average velocity.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=1.0]
- Flags: construct write read
MeanDirection: A random variable used to assign the average direction.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=6.283185307]
- Flags: construct write read
MeanPitch: A random variable used to assign the average pitch.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::ConstantRandomVariable[Constant=0.0]
- Flags: construct write read
NormalVelocity: A gaussian random variable used to calculate the next velocity value.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::NormalRandomVariable >
- Initial value: ns3::NormalRandomVariable[Mean=0.0|Variance=1.0|Bound=10.0]
- Flags: construct write read
NormalDirection: A gaussian random variable used to calculate the next direction value.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::NormalRandomVariable >
- Initial value: ns3::NormalRandomVariable[Mean=0.0|Variance=1.0|Bound=10.0]
- Flags: construct write read
NormalPitch: A gaussian random variable used to calculate the next pitch value.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::NormalRandomVariable >
- Initial value: ns3::NormalRandomVariable[Mean=0.0|Variance=1.0|Bound=10.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