Hierarchical mobility model. More...

#include "hierarchical-mobility-model.h"

Inheritance diagram for ns3::HierarchicalMobilityModel:

Collaboration diagram for ns3::HierarchicalMobilityModel:

Public Member Functions
	HierarchicalMobilityModel ()

Ptr< MobilityModel >	GetChild () const

Ptr< MobilityModel >	GetParent () const

void	SetChild (Ptr< MobilityModel > model)
	Sets the child mobility model to a new one, possibly replacing an existing one.

void	SetParent (Ptr< MobilityModel > model)
	Sets the parent mobility model to a new one, possibly replacing an existing one.

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< 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) 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::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
void	ChildChanged (Ptr< const MobilityModel > model)
	Callback for when child mobility model course change occurs.

int64_t	DoAssignStreams (int64_t) override
	The default implementation does nothing but return the passed-in parameter.

Vector	DoGetPosition () const override

Vector	DoGetVelocity () const override

void	DoInitialize () override
	Initialize() implementation.

void	DoSetPosition (const Vector &position) override

void	ParentChanged (Ptr< const MobilityModel > model)
	Callback for when parent mobility model course change occurs.

Private Attributes
Ptr< MobilityModel >	m_child
	pointer to child mobility model

Ptr< MobilityModel >	m_parent
	pointer to parent mobility 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.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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:

"/NodeList/[i]/$ns3::MobilityModel/$ns3::HierarchicalMobilityModel"

Attributes

Child: The child mobility model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::MobilityModel>
- Initial value: 0
- Flags: constructwriteread
Parent: The parent mobility model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::MobilityModel>
- Initial value: 0
- Flags: constructwriteread

Attributes defined in parent class ns3::MobilityModel

Position: The current position of the mobility model.
- Set with class: ns3::Vector3DValue
- Underlying type: Vector3D
- Flags: writeread
Velocity: The current velocity of the mobility model.
- Set with class: ns3::Vector3DValue
- Underlying type: Vector3D
- Flags: read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::MobilityModel

CourseChange: The value of the position and/or velocity vector changed
Callback signature: ns3::MobilityModel::TracedCallback

Size of this type is 88 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 55 of file hierarchical-mobility-model.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ ChildChanged()

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

private

Callback for when child mobility model course change occurs.

Parameters

model mobility mode (unused)

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

References ns3::MobilityModel::NotifyCourseChange().

Referenced by SetChild().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoAssignStreams()

int64_t ns3::HierarchicalMobilityModel::DoAssignStreams ( int64_t start )

overrideprivatevirtual

The default implementation does nothing but return the passed-in parameter.

Subclasses using random variables are expected to override this.

Parameters

start starting stream index

Returns: the number of streams used

Reimplemented from ns3::MobilityModel.

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

References ns3::MobilityModel::AssignStreams(), m_child, m_parent, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoGetPosition()

Vector ns3::HierarchicalMobilityModel::DoGetPosition ( ) const

overrideprivatevirtual

Returns: the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

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

Here is the call graph for this function:

◆ DoGetVelocity()

Vector ns3::HierarchicalMobilityModel::DoGetVelocity ( ) const

overrideprivatevirtual

Returns: the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

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

Here is the call graph for this function:

◆ DoInitialize()

void ns3::HierarchicalMobilityModel::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

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

References ns3::Object::Initialize(), ns3::Object::IsInitialized(), m_child, m_parent, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoSetPosition()

void ns3::HierarchicalMobilityModel::DoSetPosition ( const Vector & position )

overrideprivatevirtual

Parameters

position the position to set.

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::GetPosition(), m_child, m_parent, NS_LOG_FUNCTION, and ns3::MobilityModel::SetPosition().

Here is the call graph for this function:

◆ GetChild()

Ptr< MobilityModel > ns3::HierarchicalMobilityModel::GetChild ( ) const

Returns: the child mobility model.

Calling GetPosition() on the model returned by this method allows one to access the position of the child relative to its parent.

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

References m_child.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetParent()

Ptr< MobilityModel > ns3::HierarchicalMobilityModel::GetParent ( ) const

Returns: the parent mobility model.

Calling GetPosition() on the model returned by this method allows one to access the position of the parent alone, which is used as the reference position to which the child position is added.

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

References m_parent.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::HierarchicalMobilityModel::GetTypeId ( )

static

Register this type with the TypeId system.

Returns: the object TypeId

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

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

Here is the call graph for this function:

◆ ParentChanged()

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

private

Callback for when parent mobility model course change occurs.

Parameters

model mobility mode (unused)

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

References ns3::MobilityModel::NotifyCourseChange().

Referenced by SetParent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetChild()

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

Sets the child mobility model to a new one, possibly replacing an existing one.

If the child model is being replaced, then the new child mobility model's current position is also set to the previous position to ensure that the composite position is preserved by this operation.

Parameters

model new mobility model child

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

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

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetParent()

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

Sets the parent mobility model to a new one, possibly replacing an existing one.

If the parent model is being replaced, then the new position is set to the position that was set before replacement, to ensure that the composite position is preserved across changes to the parent model.

Parameters

model new mobility model parent

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

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

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_child

Ptr<MobilityModel> ns3::HierarchicalMobilityModel::m_child

private

pointer to child mobility model

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

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

◆ m_parent

Ptr<MobilityModel> ns3::HierarchicalMobilityModel::m_parent

private

pointer to parent mobility model

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

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

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

src/mobility/model/hierarchical-mobility-model.h
src/mobility/model/hierarchical-mobility-model.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::MobilityModel

TraceSources defined in parent class ns3::MobilityModel

Constructor & Destructor Documentation

◆ HierarchicalMobilityModel()

Member Function Documentation

◆ ChildChanged()

◆ DoAssignStreams()

◆ DoGetPosition()

◆ DoGetVelocity()

◆ DoInitialize()

◆ DoSetPosition()

◆ GetChild()

◆ GetParent()

◆ GetTypeId()

◆ ParentChanged()

◆ SetChild()

◆ SetParent()

Member Data Documentation

◆ m_child

◆ m_parent