A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::MobilityModel Class Referenceabstract
Mobility

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.
 
virtual Ptr< MobilityModel > Copy () const =0
 Copy function allows one to copy the underlying MobilityModel from a MobilityModel pointer, by calling each children Copy implementation.
 
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 final
 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.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- 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, bool permissive=false) 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.
 
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 Symbols inherited from ns3::ObjectBase
 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.
  • Velocity: The current velocity of the mobility model.

TraceSources

Group: Mobility
Size of this type is 80 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ TracedCallback

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

TracedCallback signature.

Parameters
[in]modelValue of the MobilityModel.

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

Constructor & Destructor Documentation

◆ MobilityModel()

ns3::MobilityModel::MobilityModel ( )

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

Referenced by ns3::ConstantAccelerationMobilityModel::GetTypeId(), ns3::ConstantPositionMobilityModel::GetTypeId(), ns3::ConstantVelocityMobilityModel::GetTypeId(), ns3::GaussMarkovMobilityModel::GetTypeId(), ns3::GeocentricConstantPositionMobilityModel::GetTypeId(), ns3::HierarchicalMobilityModel::GetTypeId(), ns3::RandomDirection2dMobilityModel::GetTypeId(), ns3::RandomWalk2dMobilityModel::GetTypeId(), ns3::RandomWalk2dOutdoorMobilityModel::GetTypeId(), ns3::RandomWaypointMobilityModel::GetTypeId(), ns3::SteadyStateRandomWaypointMobilityModel::GetTypeId(), and ns3::WaypointMobilityModel::GetTypeId().

+ Here is the caller graph for this function:

◆ ~MobilityModel()

ns3::MobilityModel::~MobilityModel ( )
overridepure virtual

Definition at line 51 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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

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

References DoAssignStreams().

Referenced by Copy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Copy()

virtual Ptr< MobilityModel > ns3::MobilityModel::Copy ( ) const
pure virtual

Copy function allows one to copy the underlying MobilityModel from a MobilityModel pointer, by calling each children Copy implementation.

This is primarily used by wraparound models for the spectrum channel.

Returns
a copy of the current mobility model

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

References AssignStreams(), GetDistanceFrom(), GetPosition(), GetPositionWithReference(), GetRelativeSpeed(), GetVelocity(), and SetPosition().

+ Here is the call 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
startstarting stream index
Returns
the number of streams used

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

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

Referenced by AssignStreams(), and DoGetVelocity().

+ 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::ConstantAccelerationMobilityModel, ns3::ConstantPositionMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::GaussMarkovMobilityModel, ns3::GeocentricConstantPositionMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWalk2dOutdoorMobilityModel, ns3::RandomWaypointMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, and ns3::WaypointMobilityModel.

References DoGetPositionWithReference().

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoGetPositionWithReference()

Vector ns3::MobilityModel::DoGetPositionWithReference ( const Vector & referencePosition) const
privatevirtual
Parameters
referencePositionthe reference position to consider
Returns
the current position.

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

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

References DoGetPosition().

Referenced by DoGetPosition(), and 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::ConstantAccelerationMobilityModel, ns3::ConstantPositionMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::GaussMarkovMobilityModel, ns3::GeocentricConstantPositionMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWalk2dOutdoorMobilityModel, ns3::RandomWaypointMobilityModel, ns3::SteadyStateRandomWaypointMobilityModel, and ns3::WaypointMobilityModel.

References DoAssignStreams().

Referenced by GetVelocity().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoSetPosition()

virtual void ns3::MobilityModel::DoSetPosition ( const Vector & position)
privatepure virtual
Parameters
positionthe position to set.

Concrete subclasses of this base class must implement this method.

Implemented in ns3::ConstantAccelerationMobilityModel, ns3::ConstantPositionMobilityModel, ns3::ConstantVelocityMobilityModel, ns3::GaussMarkovMobilityModel, ns3::GeocentricConstantPositionMobilityModel, ns3::HierarchicalMobilityModel, ns3::RandomDirection2dMobilityModel, ns3::RandomWalk2dMobilityModel, ns3::RandomWalk2dOutdoorMobilityModel, 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
positiona reference to another mobility model
Returns
the distance between the two objects. Unit is meters.

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

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

Referenced by Copy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetPosition()

Vector ns3::MobilityModel::GetPosition ( ) const
Returns
the current position

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

References DoGetPosition().

Referenced by Copy(), WifiUseAvailBwTest::DoRun(), GetTypeId(), Experiment::Run(), NetAnimExperiment::Run(), ns3::HierarchicalMobilityModel::SetChild(), and ns3::HierarchicalMobilityModel::SetParent().

+ 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
referencePositionreference position to consider
Returns
the current position based on the provided referencePosition
See also
ns3::MobilityModel::DoGetPositionWithReference

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

References DoGetPositionWithReference().

Referenced by Copy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetRelativeSpeed()

double ns3::MobilityModel::GetRelativeSpeed ( Ptr< const MobilityModel > other) const
Parameters
otherreference to another object's mobility model
Returns
the relative speed between the two objects. Unit is meters/s.

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

References GetVelocity().

Referenced by Copy().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MobilityModel::GetTypeId ( )
static

Register this type with the TypeId system.

Returns
the object TypeId

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

References ns3::Object::Object(), ns3::TypeId::ATTR_GET, ns3::TypeId::ATTR_SET, GetPosition(), GetVelocity(), m_courseChangeTrace, ns3::MakeTraceSourceAccessor(), ns3::MakeVectorAccessor(), ns3::MakeVectorChecker(), ns3::TypeId::SetParent(), and SetPosition().

+ Here is the call graph for this function:

◆ GetVelocity()

Vector ns3::MobilityModel::GetVelocity ( ) const
Returns
the current velocity.

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

References DoGetVelocity().

Referenced by Copy(), GetRelativeSpeed(), and GetTypeId().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ NotifyCourseChange()

void ns3::MobilityModel::NotifyCourseChange ( ) const
protected

Must be invoked by subclasses when the course of the position changes to notify course change listeners.

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

References m_courseChangeTrace.

Referenced by ns3::RandomDirection2dMobilityModel::BeginPause(), ns3::RandomWaypointMobilityModel::BeginWalk(), ns3::SteadyStateRandomWaypointMobilityModel::BeginWalk(), ns3::HierarchicalMobilityModel::ChildChanged(), ns3::RandomWaypointMobilityModel::DoInitializePrivate(), ns3::SteadyStateRandomWaypointMobilityModel::DoInitializePrivate(), ns3::GeocentricConstantPositionMobilityModel::DoSetGeocentricPosition(), ns3::GeocentricConstantPositionMobilityModel::DoSetGeographicPosition(), ns3::ConstantAccelerationMobilityModel::DoSetPosition(), ns3::ConstantPositionMobilityModel::DoSetPosition(), ns3::ConstantVelocityMobilityModel::DoSetPosition(), ns3::GeocentricConstantPositionMobilityModel::DoSetPosition(), ns3::WaypointMobilityModel::DoSetPosition(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::RandomWalk2dMobilityModel::DoWalk(), ns3::RandomWalk2dOutdoorMobilityModel::DoWalk(), ns3::HierarchicalMobilityModel::ParentChanged(), ns3::RandomDirection2dMobilityModel::SetDirectionAndSpeed(), ns3::ConstantVelocityMobilityModel::SetVelocity(), ns3::ConstantAccelerationMobilityModel::SetVelocityAndAcceleration(), ns3::SteadyStateRandomWaypointMobilityModel::Start(), ns3::SteadyStateRandomWaypointMobilityModel::SteadyStateBeginWalk(), and ns3::WaypointMobilityModel::Update().

+ Here is the caller graph for this function:

◆ SetPosition()

void ns3::MobilityModel::SetPosition ( const Vector & position)
Parameters
positionthe position to set.

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

References DoSetPosition().

Referenced by Copy(), ChainRegressionTest::DoRun(), Issue211Test::DoRun(), WraparoundModelTest::DoRun(), GetTypeId(), AodvExample::InstallApplications(), ns3::HierarchicalMobilityModel::SetChild(), ns3::HierarchicalMobilityModel::SetParent(), and ns3::SetSchedPosition().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_courseChangeTrace

ns3::TracedCallback<Ptr<const MobilityModel> > ns3::MobilityModel::m_courseChangeTrace
private

Used to alert subscribers that a change in direction, velocity, or position has occurred.

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

Referenced by GetTypeId(), and NotifyCourseChange().

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