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 (void) const

Ptr< MobilityModel >	GetParent (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 ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::MobilityModel
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. 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)

virtual Vector	DoGetPosition (void) const

virtual Vector	DoGetVelocity (void) const

virtual void	DoSetPosition (const Vector &position)

void	ParentChanged (Ptr< const MobilityModel > model)

Private Attributes
Ptr< MobilityModel >	m_child

Ptr< MobilityModel >	m_parent

Additional Inherited Members
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)

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. 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:

/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: construct write read
Parent: The parent mobility model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::MobilityModel>
- Initial value: 0
- Flags: construct write read

Attributes defined in parent class ns3::MobilityModel

Position: The current position of the mobility model.
- Set with class: Vector3DValue
- Underlying type: Vector3D
- Flags: write read
Velocity: The current velocity of the mobility model.
- Set with class: 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

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

Constructor & Destructor Documentation

ns3::HierarchicalMobilityModel::HierarchicalMobilityModel ( )

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

Member Function Documentation

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

private

Definition at line 171 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:

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 112 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::GetPosition(), m_child, m_parent, ns3::Vector3D::x, ns3::Vector3D::y, and ns3::Vector3D::z.

Here is the call graph for this function:

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 147 of file hierarchical-mobility-model.cc.

References ns3::MobilityModel::GetVelocity(), m_child, m_parent, ns3::Vector3D::x, ns3::Vector3D::y, and ns3::Vector3D::z.

Here is the call graph for this function:

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

privatevirtual

Parameters

position the position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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

References ns3::MobilityModel::GetPosition(), m_child, m_parent, ns3::MobilityModel::SetPosition(), ns3::Vector3D::x, ns3::Vector3D::y, and ns3::Vector3D::z.

Here is the call graph for this function:

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 100 of file hierarchical-mobility-model.cc.

References m_child.

Referenced by GetTypeId().

Here is the caller graph for this function:

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 106 of file hierarchical-mobility-model.cc.

References m_parent.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::HierarchicalMobilityModel::GetTypeId ( void )

static

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

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

Here is the call graph for this function:

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

private

Definition at line 165 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:

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

model new mobility model child

Definition at line 54 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().

Here is the call graph for this function:

Here is the caller graph for this function:

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

model new mobility model parent

Definition at line 75 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().

Here is the call graph for this function: