ocra-recipes
Doxygen documentation for the ocra-recipes repository
Classes | Public Member Functions | List of all members
ocra::TargetFrame Class Reference

Represents a 'target', i.e. something that does not depend on a model but must match with another frame. More...

#include <ControlFrame.h>

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

Classes

struct  Pimpl
 

Public Member Functions

 TargetFrame (const std::string &name, const Model &model)
 
Eigen::Displacementd getPosition () const
 
Eigen::Twistd getVelocity () const
 
Eigen::Twistd getAcceleration () const
 
Eigen::Wrenchd getWrench () const
 
Eigen::Matrix< double, 6, Eigen::Dynamic > getJacobian () const
 
bool dependsOnModelConfiguration () const
 
const ModelgetModel () const
 
void setPosition (const Eigen::Displacementd &H)
 
void setVelocity (const Eigen::Twistd &T)
 
void setAcceleration (const Eigen::Twistd &gamma)
 
void setWrench (const Eigen::Wrenchd &W)
 
- Public Member Functions inherited from ocra::ControlFrame
virtual ~ControlFrame ()=0
 
- Public Member Functions inherited from ocra::NamedInstance
 NamedInstance (const std::string &name)
 
const std::string & getName () const
 
virtual ~NamedInstance ()
 

Additional Inherited Members

- Protected Member Functions inherited from ocra::ControlFrame
 ControlFrame (const std::string &name)
 

Detailed Description

Represents a 'target', i.e. something that does not depend on a model but must match with another frame.

A target frame has its position and velocity manually defined via TargetFrame::setPosition and TargetFrame::setVelocity. It can be used to specify control objectives. Note that you always have to specify a displacement and a twist, whatever the control objective. If you are only interested in specifying a position, you can just fill the rotational part with the identity quaternion. Likewise, if only the rotational part is of interest, you can specify any position, since it will be ignored by the controller. The same goes for the twist.

Definition at line 75 of file ControlFrame.h.

Constructor & Destructor Documentation

ocra::TargetFrame::TargetFrame ( const std::string &  name,
const Model model 
)

Definition at line 41 of file ControlFrame.cpp.

Member Function Documentation

bool ocra::TargetFrame::dependsOnModelConfiguration ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 72 of file ControlFrame.cpp.

Eigen::Twistd ocra::TargetFrame::getAcceleration ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 57 of file ControlFrame.cpp.

Jacobian6d ocra::TargetFrame::getJacobian ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 67 of file ControlFrame.cpp.

const Model & ocra::TargetFrame::getModel ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 77 of file ControlFrame.cpp.

Eigen::Displacementd ocra::TargetFrame::getPosition ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 47 of file ControlFrame.cpp.

Eigen::Twistd ocra::TargetFrame::getVelocity ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 52 of file ControlFrame.cpp.

Eigen::Wrenchd ocra::TargetFrame::getWrench ( ) const
virtual

Implements ocra::ControlFrame.

Definition at line 62 of file ControlFrame.cpp.

void ocra::TargetFrame::setAcceleration ( const Eigen::Twistd &  gamma)

Definition at line 92 of file ControlFrame.cpp.

void ocra::TargetFrame::setPosition ( const Eigen::Displacementd &  H)

Definition at line 82 of file ControlFrame.cpp.

void ocra::TargetFrame::setVelocity ( const Eigen::Twistd &  T)

Definition at line 87 of file ControlFrame.cpp.

void ocra::TargetFrame::setWrench ( const Eigen::Wrenchd &  W)

Definition at line 97 of file ControlFrame.cpp.


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