yarp::dev::IControlCalibration Class Reference

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

Detailed Description

Interface for control devices, calibration commands.

Definition at line 80 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 90 of file IControlCalibration.h.

Member Function Documentation

abortCalibration()

bool IControlCalibration::abortCalibration ( )

virtual

Reimplemented in ControlBoardRemapper, and RemoteControlBoard.

Definition at line 46 of file ImplementControlCalibration.cpp.

abortPark()

bool IControlCalibration::abortPark ( )

virtual

Reimplemented in ControlBoardRemapper, and RemoteControlBoard.

Definition at line 55 of file ImplementControlCalibration.cpp.

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 yarp::dev::ImplementControlCalibration, FakeBot, ControlBoardRemapper, and RemoteControlBoard.

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 ControlBoardRemapper, FakeBot, RemoteControlBoard, and yarp::dev::ImplementControlCalibration.

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 yarp::dev::ImplementControlCalibration, RemoteControlBoard, and ControlBoardRemapper.

Definition at line 104 of file IControlCalibration.h.

setCalibrator()

bool IControlCalibration::setCalibrator ( ICalibrator *  c )

virtual

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

Parameters

c	pointer 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:

• src/libYARP_dev/src/yarp/dev/IControlCalibration.h
• src/libYARP_dev/src/yarp/dev/ImplementControlCalibration.cpp