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

Task Manager for a contact task. More...

#include <gOcraContactTaskManager.h>

Inheritance diagram for gocra::gOcraContactTaskManager:
[legend]
Collaboration diagram for gocra::gOcraContactTaskManager:
[legend]

Public Member Functions

 gOcraContactTaskManager (GHCJTController &ctrl, const ocra::Model &model, const std::string &taskName, const std::string &segmentName, Eigen::Displacementd H_segment_frame, double mu, double margin)
 
 ~gOcraContactTaskManager ()
 
void activate ()
 
void deactivate ()
 
VectorXd getTaskError ()
 
double getTaskErrorNorm ()
 
- Public Member Functions inherited from gocra::gOcraTaskManagerBase
 gOcraTaskManagerBase (gocra::GHCJTController &ctrl, const ocra::Model &model, const std::string &name)
 
double getTaskErrorNorm ()
 

Additional Inherited Members

- Protected Attributes inherited from gocra::gOcraTaskManagerBase
gocra::GHCJTControllerctrl
 
const ocra::Modelmodel
 
const std::string & name
 

Detailed Description

Task Manager for a contact task.

Definition at line 18 of file gOcraContactTaskManager.h.

Constructor & Destructor Documentation

gocra::gOcraContactTaskManager::gOcraContactTaskManager ( GHCJTController _ctrl,
const ocra::Model _model,
const std::string &  _taskName,
const std::string &  _segmentName,
Eigen::Displacementd  _H_segment_frame,
double  _mu,
double  _margin 
)

Base constructor

Parameters
_ctrlGHCJTController to connect to
_modelocra model to setup the task
_taskNameName of the tasks (prefix for the set of tasks)
_segmentNameName of segment that the contacts are attached to
_H_segment_frameContact point local to the segment
_muCoefficient of friction
_marginMargin inside the friction cone

Definition at line 16 of file gOcraContactTaskManager.cpp.

gocra::gOcraContactTaskManager::~gOcraContactTaskManager ( )

Member Function Documentation

void gocra::gOcraContactTaskManager::activate ( )
virtual

Activate function

Activates the constraint

Implements gocra::gOcraTaskManagerBase.

Definition at line 33 of file gOcraContactTaskManager.cpp.

void gocra::gOcraContactTaskManager::deactivate ( )
virtual

Deactivate function

Deactivates the constraint

Implements gocra::gOcraTaskManagerBase.

Definition at line 42 of file gOcraContactTaskManager.cpp.

VectorXd gocra::gOcraContactTaskManager::getTaskError ( )
virtual

Returns the error vector of the task

If the derived child class does not have a meaningful error, it should override this function to throw an error

Reimplemented from gocra::gOcraTaskManagerBase.

Definition at line 48 of file gOcraContactTaskManager.cpp.

double gocra::gOcraContactTaskManager::getTaskErrorNorm ( )

Definition at line 54 of file gOcraContactTaskManager.cpp.


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