A Discrete-Event Network Simulator
API
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::HierarchicalMobilityModel Class Reference

Hierarchical mobility model. More...

#include "hierarchical-mobility-model.h"

+ Inheritance diagram for ns3::HierarchicalMobilityModel:

Public Member Functions

 HierarchicalMobilityModel ()
 
Ptr< MobilityModelGetChild (void) const
 
Ptr< MobilityModelGetParent (void) const
 
void SetChild (Ptr< MobilityModel > model)
 Sets the child mobility model to a new one. More...
 
void SetParent (Ptr< MobilityModel > model)
 Sets the parent mobility model to a new one. More...
 
- 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. 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

void ChildChanged (Ptr< const MobilityModel > model)
 Callback for when child mobility model course change occurs. More...
 
virtual Vector DoGetPosition (void) const
 
virtual Vector DoGetVelocity (void) const
 
virtual void DoSetPosition (const Vector &position)
 
void ParentChanged (Ptr< const MobilityModel > model)
 Callback for when parent mobility model course change occurs. More...
 

Private Attributes

Ptr< MobilityModelm_child
 pointer to child mobility model More...
 
Ptr< MobilityModelm_parent
 pointer to parent mobility model 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

Hierarchical mobility model.


This model allows you to specify the position of a child object relative to a parent object.

Basically this is a mobility model that combines two other mobility models: a "parent" model and a "child" model. The position of the hierarchical model is always the vector sum of the parent + child positions, so that if the parent model "moves", then this model will report an equal relative movement. Useful, for instance, if you want to simulate a node inside another node that moves, such as a vehicle.

Setting the position on this model is always done using world absolute coordinates, and it changes only the child mobility model position, never the parent. The child mobility model always uses a coordinate system relative to the parent model position.

Note
: as a special case, the parent model may be NULL, which is semantically equivalent to having a ConstantPositionMobilityModel as parent positioned at origin (0,0,0). In other words, setting the parent model to NULL makes the child model and the hierarchical model start using world absolute coordinates.
Warning
: changing the parent/child mobility models in the middle of a simulation will probably not play very well with the ConfigStore APIs, so do this only if you know what you are doing.

Config Paths

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

Attributes

Attributes defined in parent class ns3::MobilityModel

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 57 of file hierarchical-mobility-model.h.

Constructor & Destructor Documentation

◆ HierarchicalMobilityModel()

ns3::HierarchicalMobilityModel::HierarchicalMobilityModel ( )

Definition at line 48 of file hierarchical-mobility-model.cc.

Member Function Documentation

◆ ChildChanged()

void ns3::HierarchicalMobilityModel::ChildChanged ( Ptr< const MobilityModel model)
private

Callback for when child mobility model course change occurs.

Definition at line 172 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::NotifyCourseChange().

Referenced by SetChild().

◆ DoGetPosition()

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

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 113 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::GetPosition(), m_child, and m_parent.

◆ DoGetVelocity()

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

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 148 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::GetVelocity(), m_child, and m_parent.

◆ DoSetPosition()

void ns3::HierarchicalMobilityModel::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 126 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::GetPosition(), m_child, m_parent, and ns3::MobilityModel::SetPosition().

◆ GetChild()

Ptr< MobilityModel > ns3::HierarchicalMobilityModel::GetChild ( void  ) const
Returns
the child mobility model.

This allows you to get access to the position of the child relative to its parent.

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

References m_child.

Referenced by GetTypeId().

◆ GetParent()

Ptr< MobilityModel > ns3::HierarchicalMobilityModel::GetParent ( void  ) const
Returns
the parent mobility model.

This allows you to get access to the position of the parent mobility model which is used as the reference position by the child mobility model.

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

References m_parent.

Referenced by GetTypeId().

◆ GetTypeId()

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

Register this type with the TypeId system.

Returns
the object TypeId

Definition at line 28 of file hierarchical-mobility-model.cc.

References GetChild(), GetParent(), ns3::MakePointerAccessor(), SetChild(), SetParent(), and ns3::TypeId::SetParent().

◆ ParentChanged()

void ns3::HierarchicalMobilityModel::ParentChanged ( Ptr< const MobilityModel model)
private

Callback for when parent mobility model course change occurs.

Definition at line 166 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::NotifyCourseChange().

Referenced by SetParent().

◆ SetChild()

void ns3::HierarchicalMobilityModel::SetChild ( Ptr< MobilityModel model)

Sets the child mobility model to a new one.

If before there already existed a child model, then the child mobility model current position is also modified to ensure that the composite position is preserved.

Parameters
modelnew mobility model child

Definition at line 55 of file hierarchical-mobility-model.cc.

References ChildChanged(), ns3::MobilityModel::GetPosition(), m_child, ns3::MakeCallback(), ns3::MobilityModel::SetPosition(), ns3::ObjectBase::TraceConnectWithoutContext(), and ns3::ObjectBase::TraceDisconnectWithoutContext().

Referenced by GetTypeId().

◆ SetParent()

void ns3::HierarchicalMobilityModel::SetParent ( Ptr< MobilityModel model)

Sets the parent mobility model to a new one.

If before there already existed a child model, then the child mobility model current position is also modified to ensure that the composite position is preserved.

Parameters
modelnew mobility model parent

Definition at line 76 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::GetPosition(), m_child, m_parent, ns3::MakeCallback(), ParentChanged(), ns3::MobilityModel::SetPosition(), ns3::ObjectBase::TraceConnectWithoutContext(), and ns3::ObjectBase::TraceDisconnectWithoutContext().

Referenced by GetTypeId().

Member Data Documentation

◆ m_child

Ptr<MobilityModel> ns3::HierarchicalMobilityModel::m_child
private

pointer to child mobility model

Definition at line 114 of file hierarchical-mobility-model.h.

Referenced by DoGetPosition(), DoGetVelocity(), DoSetPosition(), GetChild(), SetChild(), and SetParent().

◆ m_parent

Ptr<MobilityModel> ns3::HierarchicalMobilityModel::m_parent
private

pointer to parent mobility model

Definition at line 115 of file hierarchical-mobility-model.h.

Referenced by DoGetPosition(), DoGetVelocity(), DoSetPosition(), GetParent(), and SetParent().


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