Keep track of the current position and velocity of an object. More...

#include "mobility-model.h"

Inheritance diagram for ns3::MobilityModel:

Collaboration diagram for ns3::MobilityModel:

Public Types
typedef void(*	TracedCallback) (Ptr< const MobilityModel > model)
	TracedCallback signature.

Public Member Functions
	MobilityModel ()

	~MobilityModel () override=0

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model.

double	GetDistanceFrom (Ptr< const MobilityModel > position) const

Vector	GetPosition () const

Vector	GetPositionWithReference (const Vector &referencePosition) const
	This method may be used if the position returned may depend on some reference position provided.

double	GetRelativeSpeed (Ptr< const MobilityModel > other) const

Vector	GetVelocity () const

void	SetPosition (const Vector &position)

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Register this type with the TypeId system.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	NotifyCourseChange () const
	Must be invoked by subclasses when the course of the position changes to notify course change listeners.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

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

virtual Vector	DoGetPosition () const =0

virtual Vector	DoGetPositionWithReference (const Vector &referencePosition) const

virtual Vector	DoGetVelocity () const =0

virtual void	DoSetPosition (const Vector &position)=0

Private Attributes
ns3::TracedCallback< Ptr< const MobilityModel > >	m_courseChangeTrace
	Used to alert subscribers that a change in direction, velocity, or position has occurred.

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Keep track of the current position and velocity of an object.

All space coordinates in this class and its subclasses are understood to be meters or meters/s. i.e., they are all metric international units.

This is a base class for all specific mobility models.

Config Paths

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

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

Attributes

Position: The current position of the mobility model.
- Set with class: ns3::Vector3DValue
- Underlying type: Vector3D
- Flags: writeread
Velocity: The current velocity of the mobility model.
- Set with class: ns3::Vector3DValue
- Underlying type: Vector3D
- Flags: read

TraceSources

CourseChange: The value of the position and/or velocity vector changed
Callback signature: ns3::MobilityModel::TracedCallback

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

Definition at line 39 of file mobility-model.h.

Member Typedef Documentation

◆ TracedCallback

typedef void(* ns3::MobilityModel::TracedCallback) (Ptr< const MobilityModel > model)

TracedCallback signature.

Parameters

[in] model Value of the MobilityModel.

Definition at line 99 of file mobility-model.h.

Constructor & Destructor Documentation

◆ MobilityModel()

ns3::MobilityModel::MobilityModel ( )

Definition at line 58 of file mobility-model.cc.

◆ ~MobilityModel()

ns3::MobilityModel::~MobilityModel ( )

overridepure virtual

Definition at line 62 of file mobility-model.cc.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::MobilityModel::AssignStreams ( int64_t stream )

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Definition at line 118 of file mobility-model.cc.

References DoAssignStreams().

Referenced by ns3::HierarchicalMobilityModel::DoAssignStreams().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoAssignStreams()

int64_t ns3::MobilityModel::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

start starting stream index

Returns: the number of streams used

Reimplemented in ns3::RandomWalk2dOutdoorMobilityModel, ns3::GaussMarkovMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, and ns3::SteadyStateRandomWaypointMobilityModel.

Definition at line 125 of file mobility-model.cc.

Referenced by AssignStreams().

Here is the caller graph for this function:

◆ DoGetPosition()

virtual Vector ns3::MobilityModel::DoGetPosition ( ) const

privatepure virtual

Returns: the current position.

Concrete subclasses of this base class must implement this method.

Implemented in ns3::RandomWalk2dOutdoorMobilityModel, ns3::ConstantAccelerationMobilityModel, ns3::ConstantPositionMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::GaussMarkovMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, and ns3::WaypointMobilityModel.

Referenced by DoGetPositionWithReference(), GetDistanceFrom(), and GetPosition().

Here is the caller graph for this function:

◆ DoGetPositionWithReference()

Vector ns3::MobilityModel::DoGetPositionWithReference ( const Vector & referencePosition ) const

privatevirtual

Parameters

referencePosition the reference position to consider

Returns: the current position.

Unless subclasses override, this method will disregard the reference position and return "DoGetPosition ()".

Definition at line 80 of file mobility-model.cc.

References DoGetPosition().

Referenced by GetPositionWithReference().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoGetVelocity()

virtual Vector ns3::MobilityModel::DoGetVelocity ( ) const

privatepure virtual

Returns: the current velocity.

Concrete subclasses of this base class must implement this method.

Implemented in ns3::RandomWalk2dOutdoorMobilityModel, ns3::ConstantAccelerationMobilityModel, ns3::ConstantPositionMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::GaussMarkovMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, and ns3::WaypointMobilityModel.

Referenced by GetVelocity().

Here is the caller graph for this function:

◆ DoSetPosition()

virtual void ns3::MobilityModel::DoSetPosition ( const Vector & position )

privatepure virtual

Parameters

position the position to set.

Concrete subclasses of this base class must implement this method.

Implemented in ns3::RandomWalk2dOutdoorMobilityModel, ns3::ConstantAccelerationMobilityModel, ns3::ConstantPositionMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::GaussMarkovMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWaypointMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, and ns3::WaypointMobilityModel.

Referenced by SetPosition().

Here is the caller graph for this function:

◆ GetDistanceFrom()

double ns3::MobilityModel::GetDistanceFrom ( Ptr< const MobilityModel > position ) const

Parameters

position a reference to another mobility model

Returns: the distance between the two objects. Unit is meters.

Definition at line 98 of file mobility-model.cc.

References ns3::CalculateDistance(), and DoGetPosition().

Here is the call graph for this function:

◆ GetPosition()

Vector ns3::MobilityModel::GetPosition ( ) const

Returns: the current position

Definition at line 67 of file mobility-model.cc.

References DoGetPosition().

Referenced by ns3::HierarchicalMobilityModel::DoGetPosition(), WifiUseAvailBwTest::DoRun(), ns3::HierarchicalMobilityModel::DoSetPosition(), GetTypeId(), NetAnimExperiment::Run(), Experiment::Run(), ns3::HierarchicalMobilityModel::SetChild(), ns3::HierarchicalMobilityModel::SetParent(), WaypointLazyNotifyFalse::TestXPosition(), and WaypointLazyNotifyTrue::TestXPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPositionWithReference()

Vector ns3::MobilityModel::GetPositionWithReference ( const Vector & referencePosition ) const

This method may be used if the position returned may depend on some reference position provided.

For example, in a hierarchical mobility model that is buildings-aware, the child mobility model may not be able to determine if it is inside or outside of a building unless it knows the parent position.

Parameters

referencePosition reference position to consider