ns3::HierarchicalMobilityModel Class Reference

a hierachical mobility model. More...

#include <hierarchical-mobility-model.h>

Inheritance diagram for ns3::HierarchicalMobilityModel:

[legend]

Collaboration diagram for ns3::HierarchicalMobilityModel:

[legend]

List of all members.

Public Member Functions
Ptr< MobilityModel >	GetChild (void) const
Ptr< MobilityModel >	GetParent (void) const
void	SetChild (Ptr< MobilityModel > model)
void	SetParent (Ptr< MobilityModel > model)
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::HierarchicalMobilityModel.
Private Member Functions
virtual Vector	DoGetPosition (void) const
virtual void	DoSetPosition (const Vector &position)
virtual Vector	DoGetVelocity (void) const

---

Detailed Description

a hierachical 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 sytem 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.

---

Member Function Documentation

virtual Vector ns3::HierarchicalMobilityModel::DoGetPosition

(

void

)

const [private, virtual]

Returns:

the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

virtual Vector ns3::HierarchicalMobilityModel::DoGetVelocity

(

void

)

const [private, virtual]

Returns:

the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

virtual void ns3::HierarchicalMobilityModel::DoSetPosition

(

const Vector &

position

)

[private, virtual]

Parameters:

position

the position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

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.

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.

static TypeId ns3::HierarchicalMobilityModel::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::HierarchicalMobilityModel.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

• 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: VectorValue
  • Underlying type: Vector
  • Flags: write read
• Velocity: The current velocity of the mobility model.
  • Set with class: VectorValue
  • Underlying type: Vector
  • Flags: read

No TraceSources defined for this type.
TraceSources defined in parent class ns3::MobilityModel:

• CourseChange: The value of the position and/or velocity vector changed

Reimplemented from ns3::MobilityModel.

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.

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.

---

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

• src/mobility/hierarchical-mobility-model.h
• doc/introspected-doxygen.h