ns-3
ns3::HierarchicalMobilityModel Class Reference

Hierarchical mobility model. More...

#include <hierarchical-mobility-model.h>

Inheritance diagram for ns3::HierarchicalMobilityModel:
Collaboration diagram for ns3::HierarchicalMobilityModel:

List of all members.

Public Member Functions

Ptr< MobilityModelGetChild (void) const
Ptr< MobilityModelGetParent (void) const
void SetChild (Ptr< MobilityModel > model)
void SetParent (Ptr< MobilityModel > model)
- Public Member Functions inherited from ns3::MobilityModel
Vector GetPosition (void) const
void SetPosition (const Vector &position)
Vector GetVelocity (void) const
double GetDistanceFrom (Ptr< const MobilityModel > position) const
double GetRelativeSpeed (Ptr< const MobilityModel > other) const
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::HierarchicalMobilityModel.

Additional Inherited Members

- Protected Member Functions inherited from ns3::MobilityModel
void NotifyCourseChange (void) const
- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

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.

Member Function Documentation

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.

Referenced by GetTypeId().

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.

Referenced by GetTypeId().

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:

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 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.

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

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

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

Referenced by GetTypeId().

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

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

Referenced by GetTypeId().


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