ocra-recipes
Doxygen documentation for the ocra-recipes repository
Public Member Functions | Protected Member Functions | List of all members
ocra::ControlFrame Class Referenceabstract

Generic representation of a frame: gives access to its position, velocity, jacobian... More...

#include <ControlFrame.h>

Inheritance diagram for ocra::ControlFrame:
[legend]
Collaboration diagram for ocra::ControlFrame:
[legend]

Public Member Functions

virtual ~ControlFrame ()=0
 
virtual Eigen::Displacementd getPosition () const =0
 
virtual Eigen::Twistd getVelocity () const =0
 
virtual Eigen::Twistd getAcceleration () const =0
 
virtual Eigen::Wrenchd getWrench () const =0
 
virtual Eigen::Matrix< double, 6, Eigen::Dynamic > getJacobian () const =0
 
virtual bool dependsOnModelConfiguration () const =0
 
virtual const ModelgetModel () const =0
 
- Public Member Functions inherited from ocra::NamedInstance
 NamedInstance (const std::string &name)
 
const std::string & getName () const
 
virtual ~NamedInstance ()
 

Protected Member Functions

 ControlFrame (const std::string &name)
 

Detailed Description

Generic representation of a frame: gives access to its position, velocity, jacobian...

A frame is always associated to a manikin's model. However, it does not always depend on its configuration. If it depends on the configuration of the manikin's model, then the method ControlFrame::sependsOnModelConfiguration will return true. Otherwise, this method returns false, and ControlFrame::getJacobian will return a null matrix, whose size be 6 x getModel().nbDofs().

Definition at line 43 of file ControlFrame.h.

Constructor & Destructor Documentation

ocra::ControlFrame::ControlFrame ( const std::string &  name)
protected

Definition at line 10 of file ControlFrame.cpp.

ocra::ControlFrame::~ControlFrame ( )
pure virtual

Definition at line 15 of file ControlFrame.cpp.

Member Function Documentation

virtual bool ocra::ControlFrame::dependsOnModelConfiguration ( ) const
pure virtual
virtual Eigen::Twistd ocra::ControlFrame::getAcceleration ( ) const
pure virtual
virtual Eigen::Matrix<double,6,Eigen::Dynamic> ocra::ControlFrame::getJacobian ( ) const
pure virtual
virtual const Model& ocra::ControlFrame::getModel ( ) const
pure virtual
virtual Eigen::Displacementd ocra::ControlFrame::getPosition ( ) const
pure virtual
virtual Eigen::Twistd ocra::ControlFrame::getVelocity ( ) const
pure virtual
virtual Eigen::Wrenchd ocra::ControlFrame::getWrench ( ) const
pure virtual

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