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

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

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

+ Inheritance diagram for ns3::ConstantPositionMobilityModel:
+ Collaboration diagram for ns3::ConstantPositionMobilityModel:

Public Member Functions

 ConstantPositionMobilityModel ()
 Create a position located at coordinates (0,0,0) More...
 
virtual ~ConstantPositionMobilityModel ()
 
- 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<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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 Vector DoGetPosition (void) const
 
virtual Vector DoGetVelocity (void) const
 
virtual void DoSetPosition (const Vector &position)
 

Private Attributes

Vector m_position
 the constant position 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 DoDispose (void)
 Destructor implementation. 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

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

Config Paths

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

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

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

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

Definition at line 32 of file constant-position-mobility-model.h.

Constructor & Destructor Documentation

◆ ConstantPositionMobilityModel()

ns3::ConstantPositionMobilityModel::ConstantPositionMobilityModel ( )

Create a position located at coordinates (0,0,0)

Definition at line 37 of file constant-position-mobility-model.cc.

◆ ~ConstantPositionMobilityModel()

ns3::ConstantPositionMobilityModel::~ConstantPositionMobilityModel ( )
virtual

Definition at line 40 of file constant-position-mobility-model.cc.

Member Function Documentation

◆ DoGetPosition()

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

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

References m_position.

◆ DoGetVelocity()

Vector ns3::ConstantPositionMobilityModel::DoGetVelocity ( void  ) const
privatevirtual
Returns
the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

◆ DoSetPosition()

void ns3::ConstantPositionMobilityModel::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 50 of file constant-position-mobility-model.cc.

References m_position, and ns3::MobilityModel::NotifyCourseChange().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::ConstantPositionMobilityModel::GetTypeId ( void  )
static

Register this type with the TypeId system.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_position

Vector ns3::ConstantPositionMobilityModel::m_position
private

the constant position

Definition at line 51 of file constant-position-mobility-model.h.

Referenced by DoGetPosition(), and DoSetPosition().


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