Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
tsid::tasks::TaskContactForceEquality Class Reference

#include <task-contact-force-equality.hpp>

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

Public Types

typedef math::ConstraintEquality ConstraintEquality
 
typedef pinocchio::SE3 SE3
 
typedef trajectories::TrajectorySample TrajectorySample
 
typedef math::Vector Vector
 
typedef math::Vector3 Vector3
 
typedef math::Vector6 Vector6
 
- Public Types inherited from tsid::tasks::TaskBase
typedef math::ConstRefVector ConstRefVector
 
typedef pinocchio::Data Data
 
typedef robots::RobotWrapper RobotWrapper
 

Public Member Functions

const ConstraintBasecompute (double t, ConstRefVector q, ConstRefVector v, Data &data) override
 
const ConstraintBasecompute (double t, ConstRefVector q, ConstRefVector v, Data &data, const std::vector< std::shared_ptr< ContactLevel > > *contacts) override
 
int dim () const override
 Return the dimension of the task. \info should be overloaded in the child class. More...
 
virtual const contacts::ContactBasegetAssociatedContact ()
 
virtual const std::string & getAssociatedContactName () override
 
const ConstraintBasegetConstraint () const override
 
const TrajectorySamplegetExternalForce () const
 
const double & getLeakRate () const
 
const TrajectorySamplegetReference () const
 
const VectorKd () const
 
void Kd (ConstRefVector Kp)
 
const VectorKi () const
 
void Ki (ConstRefVector Ki)
 
const VectorKp () const
 
void Kp (ConstRefVector Kp)
 
void setAssociatedContact (contacts::ContactBase &contact)
 
void setExternalForce (TrajectorySample &f_ext)
 
void setLeakRate (double leak)
 
void setReference (TrajectorySample &ref)
 
 TaskContactForceEquality (const std::string &name, RobotWrapper &robot, const double dt, contacts::ContactBase &contact)
 
- Public Member Functions inherited from tsid::tasks::TaskContactForce
EIGEN_MAKE_ALIGNED_OPERATOR_NEW TaskContactForce (const std::string &name, RobotWrapper &robot)
 
- Public Member Functions inherited from tsid::tasks::TaskBase
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::Index Index
 
- Public Attributes inherited from tsid::tasks::TaskBase
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef math::ConstraintBase ConstraintBase
 

Protected Attributes

ConstraintEquality m_constraint
 
contacts::ContactBasem_contact
 
std::string m_contact_name
 
double m_dt
 
TrajectorySample m_fext
 
Vector m_forceIntegralError
 
Vector m_Kd
 
Vector m_Ki
 
Vector m_Kp
 
double m_leak_rate
 
TrajectorySample m_ref
 
- Protected Attributes inherited from tsid::tasks::TaskBase
std::string m_name
 
RobotWrapperm_robot
 Reference on the robot model. More...
 

Detailed Description

Definition at line 30 of file tasks/task-contact-force-equality.hpp.

Member Typedef Documentation

◆ ConstraintEquality

Definition at line 39 of file tasks/task-contact-force-equality.hpp.

◆ SE3

Definition at line 40 of file tasks/task-contact-force-equality.hpp.

◆ TrajectorySample

Definition at line 35 of file tasks/task-contact-force-equality.hpp.

◆ Vector

Definition at line 36 of file tasks/task-contact-force-equality.hpp.

◆ Vector3

Definition at line 38 of file tasks/task-contact-force-equality.hpp.

◆ Vector6

Definition at line 37 of file tasks/task-contact-force-equality.hpp.

Constructor & Destructor Documentation

◆ TaskContactForceEquality()

tsid::tasks::TaskContactForceEquality::TaskContactForceEquality ( const std::string &  name,
RobotWrapper robot,
const double  dt,
contacts::ContactBase contact 
)

Definition at line 28 of file src/tasks/task-contact-force-equality.cpp.

Member Function Documentation

◆ compute() [1/2]

const ConstraintBase & tsid::tasks::TaskContactForceEquality::compute ( double  t,
ConstRefVector  q,
ConstRefVector  v,
Data data 
)
overridevirtual

Implements tsid::tasks::TaskBase.

Definition at line 129 of file src/tasks/task-contact-force-equality.cpp.

◆ compute() [2/2]

const ConstraintBase & tsid::tasks::TaskContactForceEquality::compute ( double  t,
ConstRefVector  q,
ConstRefVector  v,
Data data,
const std::vector< std::shared_ptr< ContactLevel > > *  contacts 
)
overridevirtual

Contact force tasks have an additional compute method that takes as extra input argument the list of active contacts. This can be needed for force tasks that involve all contacts, such as the CoP task.

Implements tsid::tasks::TaskContactForce.

Definition at line 103 of file src/tasks/task-contact-force-equality.cpp.

◆ dim()

int tsid::tasks::TaskContactForceEquality::dim ( ) const
overridevirtual

Return the dimension of the task. \info should be overloaded in the child class.

Implements tsid::tasks::TaskBase.

Definition at line 42 of file src/tasks/task-contact-force-equality.cpp.

◆ getAssociatedContact()

const contacts::ContactBase & tsid::tasks::TaskContactForceEquality::getAssociatedContact ( )
virtual

Definition at line 75 of file src/tasks/task-contact-force-equality.cpp.

◆ getAssociatedContactName()

const std::string & tsid::tasks::TaskContactForceEquality::getAssociatedContactName ( )
overridevirtual

Return the name of the contact associated to this task if this task is associated to a specific contact. If this task is associated to multiple contact forces (all of them), returns an empty string.

Implements tsid::tasks::TaskContactForce.

Definition at line 71 of file src/tasks/task-contact-force-equality.cpp.

◆ getConstraint()

const ConstraintBase & tsid::tasks::TaskContactForceEquality::getConstraint ( ) const
overridevirtual

Implements tsid::tasks::TaskBase.

Definition at line 149 of file src/tasks/task-contact-force-equality.cpp.

◆ getExternalForce()

const TaskContactForceEquality::TrajectorySample & tsid::tasks::TaskContactForceEquality::getExternalForce ( ) const

Definition at line 99 of file src/tasks/task-contact-force-equality.cpp.

◆ getLeakRate()

const double & tsid::tasks::TaskContactForceEquality::getLeakRate ( ) const

Definition at line 47 of file src/tasks/task-contact-force-equality.cpp.

◆ getReference()

const TaskContactForceEquality::TrajectorySample & tsid::tasks::TaskContactForceEquality::getReference ( ) const

Definition at line 90 of file src/tasks/task-contact-force-equality.cpp.

◆ Kd() [1/2]

const Vector & tsid::tasks::TaskContactForceEquality::Kd ( ) const

Definition at line 45 of file src/tasks/task-contact-force-equality.cpp.

◆ Kd() [2/2]

void tsid::tasks::TaskContactForceEquality::Kd ( ConstRefVector  Kp)

Definition at line 57 of file src/tasks/task-contact-force-equality.cpp.

◆ Ki() [1/2]

const Vector & tsid::tasks::TaskContactForceEquality::Ki ( ) const

Definition at line 46 of file src/tasks/task-contact-force-equality.cpp.

◆ Ki() [2/2]

void tsid::tasks::TaskContactForceEquality::Ki ( ConstRefVector  Ki)

Definition at line 63 of file src/tasks/task-contact-force-equality.cpp.

◆ Kp() [1/2]

const Vector & tsid::tasks::TaskContactForceEquality::Kp ( ) const

Definition at line 44 of file src/tasks/task-contact-force-equality.cpp.

◆ Kp() [2/2]

void tsid::tasks::TaskContactForceEquality::Kp ( ConstRefVector  Kp)

Definition at line 51 of file src/tasks/task-contact-force-equality.cpp.

◆ setAssociatedContact()

void tsid::tasks::TaskContactForceEquality::setAssociatedContact ( contacts::ContactBase contact)

Definition at line 79 of file src/tasks/task-contact-force-equality.cpp.

◆ setExternalForce()

void tsid::tasks::TaskContactForceEquality::setExternalForce ( TrajectorySample f_ext)

Definition at line 94 of file src/tasks/task-contact-force-equality.cpp.

◆ setLeakRate()

void tsid::tasks::TaskContactForceEquality::setLeakRate ( double  leak)

Definition at line 69 of file src/tasks/task-contact-force-equality.cpp.

◆ setReference()

void tsid::tasks::TaskContactForceEquality::setReference ( TrajectorySample ref)

Definition at line 85 of file src/tasks/task-contact-force-equality.cpp.

Member Data Documentation

◆ Index

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef math::Index tsid::tasks::TaskContactForceEquality::Index

Definition at line 34 of file tasks/task-contact-force-equality.hpp.

◆ m_constraint

ConstraintEquality tsid::tasks::TaskContactForceEquality::m_constraint
protected

Definition at line 80 of file tasks/task-contact-force-equality.hpp.

◆ m_contact

contacts::ContactBase* tsid::tasks::TaskContactForceEquality::m_contact
protected

Definition at line 78 of file tasks/task-contact-force-equality.hpp.

◆ m_contact_name

std::string tsid::tasks::TaskContactForceEquality::m_contact_name
protected

Definition at line 79 of file tasks/task-contact-force-equality.hpp.

◆ m_dt

double tsid::tasks::TaskContactForceEquality::m_dt
protected

Definition at line 87 of file tasks/task-contact-force-equality.hpp.

◆ m_fext

TrajectorySample tsid::tasks::TaskContactForceEquality::m_fext
protected

Definition at line 82 of file tasks/task-contact-force-equality.hpp.

◆ m_forceIntegralError

Vector tsid::tasks::TaskContactForceEquality::m_forceIntegralError
protected

Definition at line 83 of file tasks/task-contact-force-equality.hpp.

◆ m_Kd

Vector tsid::tasks::TaskContactForceEquality::m_Kd
protected

Definition at line 85 of file tasks/task-contact-force-equality.hpp.

◆ m_Ki

Vector tsid::tasks::TaskContactForceEquality::m_Ki
protected

Definition at line 86 of file tasks/task-contact-force-equality.hpp.

◆ m_Kp

Vector tsid::tasks::TaskContactForceEquality::m_Kp
protected

Definition at line 84 of file tasks/task-contact-force-equality.hpp.

◆ m_leak_rate

double tsid::tasks::TaskContactForceEquality::m_leak_rate
protected

Definition at line 88 of file tasks/task-contact-force-equality.hpp.

◆ m_ref

TrajectorySample tsid::tasks::TaskContactForceEquality::m_ref
protected

Definition at line 81 of file tasks/task-contact-force-equality.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