A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::ConstantVelocityMobilityModel Class Reference

Mobility model for which the current speed does not change once it has been set and until it is set again explicitly to a new value. More...

#include "constant-velocity-mobility-model.h"

+ Inheritance diagram for ns3::ConstantVelocityMobilityModel:
+ Collaboration diagram for ns3::ConstantVelocityMobilityModel:

Public Member Functions

 ConstantVelocityMobilityModel ()
 Create position located at coordinates (0,0,0) with speed (0,0,0).
 
 ~ConstantVelocityMobilityModel () override
 
void SetVelocity (const Vector &speed)
 
- Public Member Functions inherited from ns3::MobilityModel
 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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::MobilityModel
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.
 

Private Member Functions

Vector DoGetPosition () const override
 
Vector DoGetVelocity () const override
 
void DoSetPosition (const Vector &position) override
 

Private Attributes

ConstantVelocityHelper m_helper
 helper object for this model
 

Additional Inherited Members

- Public Types inherited from ns3::MobilityModel
typedef void(* TracedCallback) (Ptr< const MobilityModel > model)
 TracedCallback signature.
 
- Protected Member Functions inherited from ns3::MobilityModel
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.
 

Detailed Description

Mobility model for which the current speed does not change once it has been set and until it is set again explicitly to a new value.

Config Paths

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

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

No Attributes are defined for this type.

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

Group: Mobility

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

Definition at line 27 of file constant-velocity-mobility-model.h.

Constructor & Destructor Documentation

◆ ConstantVelocityMobilityModel()

ns3::ConstantVelocityMobilityModel::ConstantVelocityMobilityModel ( )

Create position located at coordinates (0,0,0) with speed (0,0,0).

Definition at line 27 of file constant-velocity-mobility-model.cc.

◆ ~ConstantVelocityMobilityModel()

ns3::ConstantVelocityMobilityModel::~ConstantVelocityMobilityModel ( )
override

Definition at line 31 of file constant-velocity-mobility-model.cc.

Member Function Documentation

◆ DoGetPosition()

Vector ns3::ConstantVelocityMobilityModel::DoGetPosition ( ) const
overrideprivatevirtual
Returns
the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 45 of file constant-velocity-mobility-model.cc.

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

+ Here is the call graph for this function:

◆ DoGetVelocity()

Vector ns3::ConstantVelocityMobilityModel::DoGetVelocity ( ) const
overrideprivatevirtual
Returns
the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 59 of file constant-velocity-mobility-model.cc.

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

+ Here is the call graph for this function:

◆ DoSetPosition()

void ns3::ConstantVelocityMobilityModel::DoSetPosition ( const Vector & position)
overrideprivatevirtual
Parameters
positionthe position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 52 of file constant-velocity-mobility-model.cc.

References m_helper, ns3::MobilityModel::NotifyCourseChange(), and ns3::ConstantVelocityHelper::SetPosition().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::ConstantVelocityMobilityModel::GetTypeId ( )
static

Register this type with the TypeId system.

Returns
the object TypeId

Definition at line 18 of file constant-velocity-mobility-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetVelocity()

void ns3::ConstantVelocityMobilityModel::SetVelocity ( const Vector & speed)
Parameters
speedthe new speed to set.

Set the current speed now to (dx,dy,dz) Unit is meters/s

Definition at line 36 of file constant-velocity-mobility-model.cc.

References m_helper, ns3::MobilityModel::NotifyCourseChange(), ns3::ConstantVelocityHelper::SetVelocity(), ns3::ConstantVelocityHelper::Unpause(), and ns3::ConstantVelocityHelper::Update().

Referenced by ns3::SetMovement().

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

Member Data Documentation

◆ m_helper

ConstantVelocityHelper ns3::ConstantVelocityMobilityModel::m_helper
private

helper object for this model

Definition at line 54 of file constant-velocity-mobility-model.h.

Referenced by DoGetPosition(), DoGetVelocity(), DoSetPosition(), and SetVelocity().


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