tsid  1.8.0
Efficient Task Space Inverse Dynamics for Multi-body Systems based on Pinocchio
tsid::contacts::ContactBase Class Referenceabstract

Base template of a Contact. More...

#include <tsid/contacts/contact-base.hpp>

Inheritance diagram for tsid::contacts::ContactBase:
Collaboration diagram for tsid::contacts::ContactBase:

Public Types

typedef math::ConstraintInequality ConstraintInequality
 
typedef math::ConstraintEquality ConstraintEquality
 
typedef math::ConstRefVector ConstRefVector
 
typedef math::Matrix Matrix
 
typedef math::Matrix3x Matrix3x
 
typedef tasks::TaskSE3Equality TaskSE3Equality
 
typedef tasks::TaskMotion TaskMotion
 
typedef pinocchio::Data Data
 
typedef robots::RobotWrapper RobotWrapper
 

Public Member Functions

 ContactBase (const std::string &name, RobotWrapper &robot)
 
virtual ~ContactBase ()=default
 
const std::string & name () const
 
void name (const std::string &name)
 
virtual unsigned int n_motion () const =0
 Return the number of motion constraints. More...
 
virtual unsigned int n_force () const =0
 Return the number of force variables. More...
 
virtual const ConstraintBasecomputeMotionTask (const double t, ConstRefVector q, ConstRefVector v, Data &data)=0
 
virtual const ConstraintInequalitycomputeForceTask (const double t, ConstRefVector q, ConstRefVector v, const Data &data)=0
 
virtual const MatrixgetForceGeneratorMatrix ()=0
 
virtual const ConstraintEqualitycomputeForceRegularizationTask (const double t, ConstRefVector q, ConstRefVector v, const Data &data)=0
 
virtual const TaskMotiongetMotionTask () const =0
 
virtual const ConstraintBasegetMotionConstraint () const =0
 
virtual const ConstraintInequalitygetForceConstraint () const =0
 
virtual const ConstraintEqualitygetForceRegularizationTask () const =0
 
virtual double getMinNormalForce () const =0
 
virtual double getMaxNormalForce () const =0
 
virtual bool setMinNormalForce (const double minNormalForce)=0
 
virtual bool setMaxNormalForce (const double maxNormalForce)=0
 
virtual double getNormalForce (ConstRefVector f) const =0
 
virtual const Matrix3xgetContactPoints () const =0
 

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 Contact.

Member Typedef Documentation

◆ ConstraintEquality

◆ ConstraintInequality

◆ ConstRefVector

◆ Data

typedef pinocchio::Data tsid::contacts::ContactBase::Data

◆ Matrix

◆ Matrix3x

◆ RobotWrapper

◆ TaskMotion

◆ TaskSE3Equality

Constructor & Destructor Documentation

◆ ContactBase()

tsid::contacts::ContactBase::ContactBase ( const std::string &  name,
RobotWrapper robot 
)

◆ ~ContactBase()

virtual tsid::contacts::ContactBase::~ContactBase ( )
virtualdefault

Member Function Documentation

◆ computeForceRegularizationTask()

virtual const ConstraintEquality& tsid::contacts::ContactBase::computeForceRegularizationTask ( const double  t,
ConstRefVector  q,
ConstRefVector  v,
const Data data 
)
pure virtual

◆ computeForceTask()

virtual const ConstraintInequality& tsid::contacts::ContactBase::computeForceTask ( const double  t,
ConstRefVector  q,
ConstRefVector  v,
const Data data 
)
pure virtual

◆ computeMotionTask()

virtual const ConstraintBase& tsid::contacts::ContactBase::computeMotionTask ( const double  t,
ConstRefVector  q,
ConstRefVector  v,
Data data 
)
pure virtual

◆ getContactPoints()

virtual const Matrix3x& tsid::contacts::ContactBase::getContactPoints ( ) const
pure virtual

◆ getForceConstraint()

virtual const ConstraintInequality& tsid::contacts::ContactBase::getForceConstraint ( ) const
pure virtual

◆ getForceGeneratorMatrix()

virtual const Matrix& tsid::contacts::ContactBase::getForceGeneratorMatrix ( )
pure virtual

◆ getForceRegularizationTask()

virtual const ConstraintEquality& tsid::contacts::ContactBase::getForceRegularizationTask ( ) const
pure virtual

◆ getMaxNormalForce()

virtual double tsid::contacts::ContactBase::getMaxNormalForce ( ) const
pure virtual

◆ getMinNormalForce()

virtual double tsid::contacts::ContactBase::getMinNormalForce ( ) const
pure virtual

◆ getMotionConstraint()

virtual const ConstraintBase& tsid::contacts::ContactBase::getMotionConstraint ( ) const
pure virtual

◆ getMotionTask()

virtual const TaskMotion& tsid::contacts::ContactBase::getMotionTask ( ) const
pure virtual

◆ getNormalForce()

virtual double tsid::contacts::ContactBase::getNormalForce ( ConstRefVector  f) const
pure virtual

◆ n_force()

virtual unsigned int tsid::contacts::ContactBase::n_force ( ) const
pure virtual

Return the number of force variables.

Implemented in tsid::contacts::ContactTwoFramePositions, tsid::contacts::ContactPoint, and tsid::contacts::Contact6d.

◆ n_motion()

virtual unsigned int tsid::contacts::ContactBase::n_motion ( ) const
pure virtual

Return the number of motion constraints.

Implemented in tsid::contacts::ContactTwoFramePositions, tsid::contacts::ContactPoint, and tsid::contacts::Contact6d.

◆ name() [1/2]

const std::string & tsid::contacts::ContactBase::name ( ) const

◆ name() [2/2]

void tsid::contacts::ContactBase::name ( const std::string &  name)

◆ setMaxNormalForce()

virtual bool tsid::contacts::ContactBase::setMaxNormalForce ( const double  maxNormalForce)
pure virtual

◆ setMinNormalForce()

virtual bool tsid::contacts::ContactBase::setMinNormalForce ( const double  minNormalForce)
pure virtual

Member Data Documentation

◆ ConstraintBase

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef math::ConstraintBase tsid::contacts::ContactBase::ConstraintBase

◆ m_name

std::string tsid::contacts::ContactBase::m_name
protected

◆ m_robot

RobotWrapper& tsid::contacts::ContactBase::m_robot
protected

Reference on the robot model.


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