Keep track of the current position and velocity of an object. More...
#include "mobility-model.h"
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. | |
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.
ns3::MobilityModel is accessible through the following paths with Config::Set and Config::Connect:
Vector3D
Vector3D
Size of this type is 48 bytes (on a 64-bit architecture).
Definition at line 39 of file mobility-model.h.
typedef void(* ns3::MobilityModel::TracedCallback) (Ptr< const MobilityModel > model) |
TracedCallback signature.
[in] | model | Value of the MobilityModel. |
Definition at line 99 of file mobility-model.h.
ns3::MobilityModel::MobilityModel | ( | ) |
Definition at line 58 of file mobility-model.cc.
|
overridepure virtual |
Definition at line 62 of file mobility-model.cc.
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.
stream | first stream index to use |
Definition at line 118 of file mobility-model.cc.
References DoAssignStreams().
Referenced by ns3::HierarchicalMobilityModel::DoAssignStreams().
|
privatevirtual |
The default implementation does nothing but return the passed-in parameter.
Subclasses using random variables are expected to override this.
start | starting stream index |
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().
|
privatepure virtual |
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().
|
privatevirtual |
referencePosition | the reference position to consider |
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().
|
privatepure virtual |
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().
|
privatepure virtual |
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().
double ns3::MobilityModel::GetDistanceFrom | ( | Ptr< const MobilityModel > | position | ) | const |
position | a reference to another mobility model |
Definition at line 98 of file mobility-model.cc.
References ns3::CalculateDistance(), and DoGetPosition().
Vector ns3::MobilityModel::GetPosition | ( | ) | const |
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().
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.
referencePosition | reference position to consider |
Definition at line 73 of file mobility-model.cc.
References DoGetPositionWithReference().
Referenced by ns3::HierarchicalMobilityModel::DoGetPosition().
double ns3::MobilityModel::GetRelativeSpeed | ( | Ptr< const MobilityModel > | other | ) | const |
other | reference to another object's mobility model |
Definition at line 106 of file mobility-model.cc.
References GetVelocity().
|
static |
Register this type with the TypeId system.
Definition at line 32 of file mobility-model.cc.
References ns3::TypeId::ATTR_GET, ns3::TypeId::ATTR_SET, GetPosition(), GetVelocity(), m_courseChangeTrace, ns3::MakeTraceSourceAccessor(), ns3::MakeVectorAccessor(), ns3::MakeVectorChecker(), ns3::TypeId::SetParent(), and SetPosition().
Vector ns3::MobilityModel::GetVelocity | ( | ) | const |
Definition at line 86 of file mobility-model.cc.
References DoGetVelocity().
Referenced by ns3::HierarchicalMobilityModel::DoGetVelocity(), GetRelativeSpeed(), and GetTypeId().
|
protected |
Must be invoked by subclasses when the course of the position changes to notify course change listeners.
Definition at line 112 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::ConstantAccelerationMobilityModel::DoSetPosition(), ns3::ConstantPositionMobilityModel::DoSetPosition(), ns3::ConstantVelocityMobilityModel::DoSetPosition(), ns3::WaypointMobilityModel::DoSetPosition(), ns3::RandomWalk2dOutdoorMobilityModel::DoWalk(), ns3::GaussMarkovMobilityModel::DoWalk(), ns3::RandomWalk2dMobilityModel::DoWalk(), ns3::HierarchicalMobilityModel::ParentChanged(), ns3::RandomDirection2dMobilityModel::SetDirectionAndSpeed(), ns3::ConstantVelocityMobilityModel::SetVelocity(), ns3::ConstantAccelerationMobilityModel::SetVelocityAndAcceleration(), ns3::SteadyStateRandomWaypointMobilityModel::Start(), ns3::SteadyStateRandomWaypointMobilityModel::SteadyStateBeginWalk(), and ns3::WaypointMobilityModel::Update().
void ns3::MobilityModel::SetPosition | ( | const Vector & | position | ) |
position | the position to set. |
Definition at line 92 of file mobility-model.cc.
References DoSetPosition().
Referenced by JakesPropagationExample::JakesPropagationExample(), ChainRegressionTest::DoRun(), WaypointInitialPositionIsWaypoint::DoRun(), Issue211Test::DoRun(), ns3::HierarchicalMobilityModel::DoSetPosition(), GetTypeId(), ns3::GroupMobilityHelper::Install(), AodvExample::InstallApplications(), LteRrcConnectionEstablishmentErrorTestCase::JumpAway(), LteRadioLinkFailureTestCase::JumpAway(), LteRrcConnectionEstablishmentErrorTestCase::JumpBack(), ns3::HierarchicalMobilityModel::SetChild(), ns3::HierarchicalMobilityModel::SetParent(), ns3::SetSchedPosition(), LteFrAreaTestCase::SimpleTeleportUe(), LteUeMeasurementsPiecewiseTestCase3::TeleportEnbNear(), LteUeMeasurementsPiecewiseTestCase1::TeleportFar(), LteUeMeasurementsPiecewiseTestCase2::TeleportFar(), LteUeMeasurementsPiecewiseTestCase1::TeleportNear(), LteUeMeasurementsPiecewiseTestCase2::TeleportNear(), LteFrAreaTestCase::TeleportUe(), LteUplinkPowerControlTestCase::TeleportUe(), LteUeMeasurementsPiecewiseTestCase1::TeleportVeryFar(), LteUeMeasurementsPiecewiseTestCase2::TeleportVeryFar(), LteUeMeasurementsPiecewiseTestCase1::TeleportVeryNear(), and LteUeMeasurementsPiecewiseTestCase2::TeleportVeryNear().
|
private |
Used to alert subscribers that a change in direction, velocity, or position has occurred.
Definition at line 151 of file mobility-model.h.
Referenced by GetTypeId(), and NotifyCourseChange().