ns3::HierarchicalMobilityModel Class Reference

a hierachical mobility model. More...

#include <hierarchical-mobility-model.h>

Inheritance diagram for ns3::HierarchicalMobilityModel:
Inheritance graph
[legend]
Collaboration diagram for ns3::HierarchicalMobilityModel:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 HierarchicalMobilityModel ()
Ptr< MobilityModelGetChild (void) const
Ptr< MobilityModelGetParent (void) const

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
void SetChild (Ptr< MobilityModel > model)
void SetParent (Ptr< MobilityModel > model)
void ParentChanged (Ptr< const MobilityModel > model)
void ChildChanged (Ptr< const MobilityModel > model)

Private Attributes

Ptr< MobilityModelm_child
Ptr< MobilityModelm_parent

Detailed Description

a hierachical mobility model.

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

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


Constructor & Destructor Documentation

ns3::HierarchicalMobilityModel::HierarchicalMobilityModel (  ) 

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


Member Function Documentation

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

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

References ns3::MobilityModel::NotifyCourseChange().

Referenced by SetChild().

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.

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

References m_child, m_parent, ns3::Vector::x, ns3::Vector::y, and ns3::Vector::z.

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.

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

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.

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

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

References m_child.

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.

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

References m_parent.

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]/$ns3MobilityModel/$ns3HierarchicalMobilityModel

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.

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

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

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

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

References ns3::MobilityModel::NotifyCourseChange().

Referenced by SetParent().

void ns3::HierarchicalMobilityModel::SetChild ( Ptr< MobilityModel model  )  [private]

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

References ChildChanged(), m_child, and ns3::MakeCallback().

Referenced by GetTypeId().

void ns3::HierarchicalMobilityModel::SetParent ( Ptr< MobilityModel model  )  [private]

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

References m_parent, ns3::MakeCallback(), and ParentChanged().

Referenced by GetTypeId().


Member Data Documentation

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

Referenced by DoGetPosition(), GetChild(), and SetChild().

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

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


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:11:54 2009 for NS-3 by  doxygen 1.6.3