Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
tsid::tasks::TaskBase Class Referenceabstract

Base template of a Task. Each class is defined according to a constant model of a robot. More...

#include <task-base.hpp>

Inheritance diagram for tsid::tasks::TaskBase:
Inheritance graph
[legend]

Public Types

typedef math::ConstRefVector ConstRefVector
 
typedef pinocchio::Data Data
 
typedef robots::RobotWrapper RobotWrapper
 

Public Member Functions

virtual const ConstraintBasecompute (double t, ConstRefVector q, ConstRefVector v, Data &data)=0
 
virtual int dim () const =0
 Return the dimension of the task. \info should be overloaded in the child class. More...
 
virtual const ConstraintBasegetConstraint () const =0
 
const std::string & name () const
 
void name (const std::string &name)
 
 TaskBase (const std::string &name, RobotWrapper &robot)
 
virtual ~TaskBase ()=default
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef math::ConstraintBase ConstraintBase
 

Protected Attributes

std::string m_name
 
RobotWrapperm_robot
 Reference on the robot model. More...
 

Detailed Description

Base template of a Task. Each class is defined according to a constant model of a robot.

Definition at line 34 of file task-base.hpp.

Member Typedef Documentation

◆ ConstRefVector

typedef math::ConstRefVector tsid::tasks::TaskBase::ConstRefVector

Definition at line 39 of file task-base.hpp.

◆ Data

Definition at line 40 of file task-base.hpp.

◆ RobotWrapper

Definition at line 41 of file task-base.hpp.

Constructor & Destructor Documentation

◆ TaskBase()

tsid::tasks::TaskBase::TaskBase ( const std::string &  name,
RobotWrapper robot 
)

Definition at line 22 of file task-base.cpp.

◆ ~TaskBase()

virtual tsid::tasks::TaskBase::~TaskBase ( )
virtualdefault

Member Function Documentation

◆ compute()

virtual const ConstraintBase& tsid::tasks::TaskBase::compute ( double  t,
ConstRefVector  q,
ConstRefVector  v,
Data data 
)
pure virtual

◆ dim()

virtual int tsid::tasks::TaskBase::dim ( ) const
pure virtual

◆ getConstraint()

virtual const ConstraintBase& tsid::tasks::TaskBase::getConstraint ( ) const
pure virtual

◆ name() [1/2]

const std::string & tsid::tasks::TaskBase::name ( ) const

Definition at line 25 of file task-base.cpp.

◆ name() [2/2]

void tsid::tasks::TaskBase::name ( const std::string &  name)

Definition at line 27 of file task-base.cpp.

Member Data Documentation

◆ ConstraintBase

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef math::ConstraintBase tsid::tasks::TaskBase::ConstraintBase

Definition at line 38 of file task-base.hpp.

◆ m_name

std::string tsid::tasks::TaskBase::m_name
protected

Definition at line 61 of file task-base.hpp.

◆ m_robot

RobotWrapper& tsid::tasks::TaskBase::m_robot
protected

Reference on the robot model.

Definition at line 64 of file task-base.hpp.


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


tsid
Author(s): Andrea Del Prete, Justin Carpentier
autogenerated on Sat May 3 2025 02:48:17