sofa::component::MappedObject< DataTypes > Class Template Reference

#include <MappedObject.h>

Inheritance diagram for sofa::component::MappedObject< DataTypes >:

Inheritance graph
[legend]
Collaboration diagram for sofa::component::MappedObject< DataTypes >:

Collaboration graph
[legend]

Public Types

typedef MappedModel< DataTypes > Inherited
typedef DataTypes::VecCoord VecCoord
 Container of Coord values with the same API as sofa::helper::vector.
typedef DataTypes::VecDeriv VecDeriv
 Container of Deriv values with the same API as sofa::helper::vector.
typedef DataTypes::Coord Coord
 Position values.
typedef DataTypes::Deriv Deriv
 Derivative values (velocity, forces, displacements).
typedef DataTypes::Real Real
 Scalar values (float or double).

Public Member Functions

 MappedObject ()
virtual ~MappedObject ()
virtual void init ()
 Initialization method called at graph modification, during bottom-up traversal.
VecCoord * getX ()
 Return the current position vector (read-write access).
VecDeriv * getV ()
 Return the current velocity vector (read-write access).
const VecCoord * getX () const
 Return the current position vector (read-only access).
const VecDeriv * getV () const
 Return the current velocity vector (read-only access).

Data Fields

Data< VecCoord > f_X
Data< VecDeriv > f_V

Protected Attributes

MappedObjectInternalData
< DataTypes > 
data

Detailed Description

template<class DataTypes>
class sofa::component::MappedObject< DataTypes >

Definition at line 52 of file MappedObject.h.


Member Typedef Documentation

template<class DataTypes >
typedef DataTypes::Coord sofa::component::MappedObject< DataTypes >::Coord

Position values.

Reimplemented from sofa::core::componentmodel::behavior::MappedModel< DataTypes >.

Definition at line 58 of file MappedObject.h.

template<class DataTypes >
typedef DataTypes::Deriv sofa::component::MappedObject< DataTypes >::Deriv

Derivative values (velocity, forces, displacements).

Reimplemented from sofa::core::componentmodel::behavior::MappedModel< DataTypes >.

Definition at line 59 of file MappedObject.h.

template<class DataTypes >
typedef MappedModel<DataTypes> sofa::component::MappedObject< DataTypes >::Inherited

Definition at line 55 of file MappedObject.h.

template<class DataTypes >
typedef DataTypes::Real sofa::component::MappedObject< DataTypes >::Real

Scalar values (float or double).

Reimplemented from sofa::core::componentmodel::behavior::MappedModel< DataTypes >.

Definition at line 60 of file MappedObject.h.

template<class DataTypes >
typedef DataTypes::VecCoord sofa::component::MappedObject< DataTypes >::VecCoord

Container of Coord values with the same API as sofa::helper::vector.

Reimplemented from sofa::core::componentmodel::behavior::MappedModel< DataTypes >.

Definition at line 56 of file MappedObject.h.

template<class DataTypes >
typedef DataTypes::VecDeriv sofa::component::MappedObject< DataTypes >::VecDeriv

Container of Deriv values with the same API as sofa::helper::vector.

Reimplemented from sofa::core::componentmodel::behavior::MappedModel< DataTypes >.

Definition at line 57 of file MappedObject.h.


Constructor & Destructor Documentation

template<class DataTypes >
sofa::component::MappedObject< DataTypes >::MappedObject (  )  [inline]

Definition at line 38 of file MappedObject.inl.

template<class DataTypes >
sofa::component::MappedObject< DataTypes >::~MappedObject (  )  [inline, virtual]

Definition at line 45 of file MappedObject.inl.


Member Function Documentation

template<class DataTypes >
const VecDeriv* sofa::component::MappedObject< DataTypes >::getV (  )  const [inline, virtual]

Return the current velocity vector (read-only access).

Implements sofa::core::componentmodel::behavior::State< TDataTypes >.

Definition at line 81 of file MappedObject.h.

References sofa::component::MappedObject< DataTypes >::f_V.

template<class DataTypes >
VecDeriv* sofa::component::MappedObject< DataTypes >::getV (  )  [inline, virtual]

Return the current velocity vector (read-write access).

Implements sofa::core::componentmodel::behavior::State< TDataTypes >.

Definition at line 78 of file MappedObject.h.

References sofa::component::MappedObject< DataTypes >::f_V.

template<class DataTypes >
const VecCoord* sofa::component::MappedObject< DataTypes >::getX (  )  const [inline, virtual]

Return the current position vector (read-only access).

Implements sofa::core::componentmodel::behavior::State< TDataTypes >.

Definition at line 80 of file MappedObject.h.

References sofa::component::MappedObject< DataTypes >::f_X.

template<class DataTypes >
VecCoord* sofa::component::MappedObject< DataTypes >::getX (  )  [inline, virtual]

Return the current position vector (read-write access).

Implements sofa::core::componentmodel::behavior::State< TDataTypes >.

Definition at line 77 of file MappedObject.h.

References sofa::component::MappedObject< DataTypes >::f_X.

Referenced by sofa::component::MappedObject< DataTypes >::init().

template<class DataTypes >
void sofa::component::MappedObject< DataTypes >::init ( void   )  [inline, virtual]


Field Documentation

template<class DataTypes >
MappedObjectInternalData<DataTypes> sofa::component::MappedObject< DataTypes >::data [protected]

Definition at line 64 of file MappedObject.h.

template<class DataTypes >
Data<VecDeriv> sofa::component::MappedObject< DataTypes >::f_V

Definition at line 75 of file MappedObject.h.

Referenced by sofa::component::MappedObject< DataTypes >::getV().

template<class DataTypes >
Data<VecCoord> sofa::component::MappedObject< DataTypes >::f_X

Definition at line 74 of file MappedObject.h.

Referenced by sofa::component::MappedObject< DataTypes >::getX().


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

Generated on Sun Nov 23 04:13:26 2008 for Sofa by  doxygen 1.5.7.1