A Discrete-Event Network Simulator
API
ns3::GaussMarkovMobilityModel Class Reference

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)
 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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::MobilityModel
static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. 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)
 Destructor implementation. More...
 
virtual Vector DoGetPosition (void) const
 
virtual Vector DoGetVelocity (void) const
 
virtual void DoSetPosition (const Vector &position)
 
void DoWalk (Time timeLeft)
 Perform a walk operation. More...
 
void Start (void)
 Initialize the model and calculate new velocity, direction, and pitch. More...
 

Private Attributes

double m_alpha
 tunable constant in the model More...
 
Box m_bounds
 bounding box More...
 
double m_Direction
 current direction More...
 
EventId m_event
 event id of scheduled start More...
 
ConstantVelocityHelper m_helper
 constant velocity helper More...
 
double m_meanDirection
 current mean direction More...
 
double m_meanPitch
 current mean pitch More...
 
double m_meanVelocity
 current mean velocity More...
 
Ptr< NormalRandomVariablem_normalDirection
 Gaussian rv for next direction value. More...
 
Ptr< NormalRandomVariablem_normalPitch
 Gaussian rv for next pitch. More...
 
Ptr< NormalRandomVariablem_normalVelocity
 Gaussian rv used to for next velocity. More...
 
double m_Pitch
 current pitch More...
 
Ptr< RandomVariableStreamm_rndMeanDirection
 rv used to assign avg direction More...
 
Ptr< RandomVariableStreamm_rndMeanPitch
 rv used to assign avg. More...
 
Ptr< RandomVariableStreamm_rndMeanVelocity
 rv used to assign avg velocity More...
 
Time m_timeStep
 duraiton after which direction and speed should change More...
 
double m_Velocity
 current velocity More...
 

Additional Inherited Members

- Public Types inherited from ns3::MobilityModel
typedef void(* TracedCallback) (Ptr< const MobilityModel > model)
 TracedCallback signature. More...
 
- 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)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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

Config Paths

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

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

Attributes

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 are defined for this type.

TraceSources defined in parent class ns3::MobilityModel

Size of this type is 304 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

ns3::GaussMarkovMobilityModel::GaussMarkovMobilityModel ( )

Member Function Documentation

int64_t ns3::GaussMarkovMobilityModel::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.

Parameters
startstarting stream index
Returns
the number of streams used

Reimplemented from ns3::MobilityModel.

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

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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 196 of file gauss-markov-mobility-model.cc.

References ns3::Object::DoDispose().

+ Here is the call graph for this function:

Vector ns3::GaussMarkovMobilityModel::DoGetPosition ( void  ) const
privatevirtual
Returns
the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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
Returns
the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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
Parameters
positionthe position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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:

TypeId ns3::GaussMarkovMobilityModel::GetTypeId ( void  )
static
void ns3::GaussMarkovMobilityModel::Start ( void  )
private

Member Data Documentation

double ns3::GaussMarkovMobilityModel::m_alpha
private

tunable constant in the model

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

Referenced by GetTypeId(), and Start().

Box ns3::GaussMarkovMobilityModel::m_bounds
private

bounding box

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

Referenced by DoWalk(), and GetTypeId().

double ns3::GaussMarkovMobilityModel::m_Direction
private

current direction

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

Referenced by DoWalk(), and Start().

EventId ns3::GaussMarkovMobilityModel::m_event
private

event id of scheduled start

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

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

ConstantVelocityHelper ns3::GaussMarkovMobilityModel::m_helper
private

constant velocity helper

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

Referenced by DoGetPosition(), DoGetVelocity(), DoSetPosition(), DoWalk(), GaussMarkovMobilityModel(), and Start().

double ns3::GaussMarkovMobilityModel::m_meanDirection
private

current mean direction

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

Referenced by DoWalk(), GaussMarkovMobilityModel(), and Start().

double ns3::GaussMarkovMobilityModel::m_meanPitch
private

current mean pitch

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

Referenced by DoWalk(), GaussMarkovMobilityModel(), and Start().

double ns3::GaussMarkovMobilityModel::m_meanVelocity
private

current mean velocity

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

Referenced by GaussMarkovMobilityModel(), and Start().

Ptr<NormalRandomVariable> ns3::GaussMarkovMobilityModel::m_normalDirection
private

Gaussian rv for next direction value.

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

Referenced by DoAssignStreams(), GetTypeId(), and Start().

Ptr<NormalRandomVariable> ns3::GaussMarkovMobilityModel::m_normalPitch
private

Gaussian rv for next pitch.

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

Referenced by DoAssignStreams(), GetTypeId(), and Start().

Ptr<NormalRandomVariable> ns3::GaussMarkovMobilityModel::m_normalVelocity
private

Gaussian rv used to for next velocity.

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

Referenced by DoAssignStreams(), GetTypeId(), and Start().

double ns3::GaussMarkovMobilityModel::m_Pitch
private

current pitch

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

Referenced by DoWalk(), and Start().

Ptr<RandomVariableStream> ns3::GaussMarkovMobilityModel::m_rndMeanDirection
private

rv used to assign avg direction

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

Referenced by DoAssignStreams(), GetTypeId(), and Start().

Ptr<RandomVariableStream> ns3::GaussMarkovMobilityModel::m_rndMeanPitch
private

rv used to assign avg.

pitch

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

Referenced by DoAssignStreams(), GetTypeId(), and Start().

Ptr<RandomVariableStream> ns3::GaussMarkovMobilityModel::m_rndMeanVelocity
private

rv used to assign avg velocity

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

Referenced by DoAssignStreams(), GetTypeId(), and Start().

Time ns3::GaussMarkovMobilityModel::m_timeStep
private

duraiton after which direction and speed should change

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

Referenced by GetTypeId(), and Start().

double ns3::GaussMarkovMobilityModel::m_Velocity
private

current velocity

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

Referenced by Start().


The documentation for this class was generated from the following files: