YARP
Yet Another Robot Platform
yarp::dev::IControlCalibration Class Referenceabstract

Interface for control devices, calibration commands. More...

#include <yarp/dev/IControlCalibration.h>

+ Inheritance diagram for yarp::dev::IControlCalibration:

Public Member Functions

 IControlCalibration ()
 
virtual ~IControlCalibration ()
 Destructor. More...
 
virtual bool calibrateAxisWithParams (int axis, unsigned int type, double p1, double p2, double p3)=0
 Start calibration, this method is very often platform specific. More...
 
virtual bool setCalibrationParameters (int axis, const CalibrationParameters &params)
 Start calibration, this method is very often platform specific. More...
 
virtual bool calibrationDone (int j)=0
 Check if the calibration is terminated, on a particular joint. More...
 
virtual bool setCalibrator (ICalibrator *c)
 Set the calibrator object to be used to calibrate the robot. More...
 
virtual bool calibrateRobot ()
 Calibrate robot by using an external calibrator. More...
 
virtual bool park (bool wait=true)
 
virtual bool abortCalibration ()
 
virtual bool abortPark ()
 

Detailed Description

Interface for control devices, calibration commands.

Definition at line 81 of file IControlCalibration.h.

Constructor & Destructor Documentation

◆ IControlCalibration()

IControlCalibration::IControlCalibration ( )

Definition at line 16 of file ImplementControlCalibration.cpp.

◆ ~IControlCalibration()

virtual yarp::dev::IControlCalibration::~IControlCalibration ( )
inlinevirtual

Destructor.

Definition at line 91 of file IControlCalibration.h.

Member Function Documentation

◆ abortCalibration()

bool IControlCalibration::abortCalibration ( )
virtual

◆ abortPark()

bool IControlCalibration::abortPark ( )
virtual

◆ calibrateAxisWithParams()

virtual bool yarp::dev::IControlCalibration::calibrateAxisWithParams ( int  axis,
unsigned int  type,
double  p1,
double  p2,
double  p3 
)
pure virtual

Start calibration, this method is very often platform specific.

Returns
true/false on success failure

Implemented in RemoteControlBoard, ControlBoardWrapperControlCalibration, ControlBoardRemapper, FakeBot, and yarp::dev::ImplementControlCalibration.

◆ calibrateRobot()

bool IControlCalibration::calibrateRobot ( )
virtual

Calibrate robot by using an external calibrator.

The external calibrator must be previously set by calling the setCalibration() method.

Returns
true/false on success failure

Reimplemented in RemoteControlBoard.

Definition at line 32 of file ImplementControlCalibration.cpp.

◆ calibrationDone()

virtual bool yarp::dev::IControlCalibration::calibrationDone ( int  j)
pure virtual

Check if the calibration is terminated, on a particular joint.

Non blocking.

Returns
true/false

Implemented in yarp::dev::ImplementControlCalibration, RemoteControlBoard, FakeBot, ControlBoardWrapperControlCalibration, and ControlBoardRemapper.

◆ park()

bool IControlCalibration::park ( bool  wait = true)
virtual

Reimplemented in RemoteControlBoard.

Definition at line 64 of file ImplementControlCalibration.cpp.

◆ setCalibrationParameters()

virtual bool yarp::dev::IControlCalibration::setCalibrationParameters ( int  axis,
const CalibrationParameters params 
)
inlinevirtual

Start calibration, this method is very often platform specific.

Returns
true/false on success failure

Reimplemented in ControlBoardWrapperControlCalibration, ControlBoardRemapper, RemoteControlBoard, and yarp::dev::ImplementControlCalibration.

Definition at line 105 of file IControlCalibration.h.

◆ setCalibrator()

bool IControlCalibration::setCalibrator ( ICalibrator c)
virtual

Set the calibrator object to be used to calibrate the robot.

Parameters
cpointer to the calibrator object
Returns
true/false on success failure

Definition at line 21 of file ImplementControlCalibration.cpp.


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