IRemoteCalibrator interface is meant to remotize the access of the calibration device in order to allow users to remotely call the calibration procedure for a single joint or the whole device and let the calibrator do the job. More...
#include <yarp/dev/IRemoteCalibrator.h>
Inheritance diagram for yarp::dev::IRemoteCalibrator:Public Member Functions | |
| IRemoteCalibrator () | |
| This interface is meant to remotize the access of the calibration device in order to allow users to remotely call the calibration procedure for a single joint or the whole device and let the calibrator do the job. | |
| virtual | ~IRemoteCalibrator ()=default |
| virtual yarp::dev::ReturnValue | setCalibratorDevice (yarp::dev::IRemoteCalibrator *dev) |
| setCalibratorDevice: store the pointer to the calibrator device. | |
| virtual yarp::dev::IRemoteCalibrator * | getCalibratorDevice () |
| getCalibratorDevice: return the pointer stored with the setCalibratorDevice | |
| virtual yarp::dev::ReturnValue | isCalibratorDevicePresent (bool *isCalib) |
| isCalibratorDevicePresent: check if a calibrator device has been set | |
| virtual yarp::dev::ReturnValue | releaseCalibratorDevice () |
| releaseCalibratorDevice: reset the internal pointer to NULL when stop using the calibrator | |
| virtual yarp::dev::ReturnValue | calibrateSingleJoint (int j)=0 |
| calibrateSingleJoint: call the calibration procedure for the single joint | |
| virtual yarp::dev::ReturnValue | calibrateWholePart ()=0 |
| calibrateWholePart: call the procedure for calibrating the whole device | |
| virtual yarp::dev::ReturnValue | homingSingleJoint (int j)=0 |
| homingSingleJoint: call the homing procedure for a single joint | |
| virtual yarp::dev::ReturnValue | homingWholePart ()=0 |
| homingWholePart: call the homing procedure for a the whole part/device | |
| virtual yarp::dev::ReturnValue | parkSingleJoint (int j, bool _wait=true)=0 |
| parkSingleJoint(): start the parking procedure for the single joint | |
| virtual yarp::dev::ReturnValue | parkWholePart ()=0 |
| parkWholePart: start the parking procedure for the whole part | |
| virtual yarp::dev::ReturnValue | quitCalibrate ()=0 |
| quitCalibrate: interrupt the calibration procedure | |
| virtual yarp::dev::ReturnValue | quitPark ()=0 |
| quitPark: interrupt the park procedure | |
IRemoteCalibrator interface is meant to remotize the access of the calibration device in order to allow users to remotely call the calibration procedure for a single joint or the whole device and let the calibrator do the job.
Main difference between this interface and remotizing the iControlCalibration interfaces is that in this case we are calling a proper iCalibrator device (whose interface is described above) that knows the correct procedure and the correct parameters for the calibration, so that user doesn't have to worry about configuration. This is meant to be used by network wrapper devices
Definition at line 28 of file IRemoteCalibrator.h.
| IRemoteCalibrator::IRemoteCalibrator | ( | ) |
This interface is meant to remotize the access of the calibration device in order to allow users to remotely call the calibration procedure for a single joint or the whole device and let the calibrator do the job.
Main difference between this interface and remotizing the iControlCalibration interfaces is that in this case we are calling a proper iCalibrator device that knows the correct procedure and the correct parameters for the calibration, so that user doesn't have to worry about configuration parameters.
Definition at line 20 of file IRemoteCalibrator.cpp.
|
virtualdefault |
|
pure virtual |
calibrateSingleJoint: call the calibration procedure for the single joint
| j | joint to be calibrated |
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
pure virtual |
calibrateWholePart: call the procedure for calibrating the whole device
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
virtual |
getCalibratorDevice: return the pointer stored with the setCalibratorDevice
Reimplemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, and FakeCalibrator.
Definition at line 31 of file IRemoteCalibrator.cpp.
|
pure virtual |
homingSingleJoint: call the homing procedure for a single joint
| j | joint to be calibrated |
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
pure virtual |
homingWholePart: call the homing procedure for a the whole part/device
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
virtual |
isCalibratorDevicePresent: check if a calibrator device has been set
Reimplemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, and ControlBoard_nwc_yarp.
Definition at line 36 of file IRemoteCalibrator.cpp.
|
pure virtual |
parkSingleJoint(): start the parking procedure for the single joint
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
pure virtual |
parkWholePart: start the parking procedure for the whole part
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
pure virtual |
quitCalibrate: interrupt the calibration procedure
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
pure virtual |
quitPark: interrupt the park procedure
Implemented in yarp::dev::xHandControlBoard, ControlBoardRemappingEngine, FakeCalibrator, and ControlBoard_nwc_yarp.
|
virtual |
releaseCalibratorDevice: reset the internal pointer to NULL when stop using the calibrator
Definition at line 42 of file IRemoteCalibrator.cpp.
|
virtual |
setCalibratorDevice: store the pointer to the calibrator device.
Has a default implementation and it is meant to be called only by wrapper devices attached to the calibrator. It will be not used by remote device like remoteControlBoard.
| dev | device implementing the IRemotizableCalibrator interface |
Definition at line 25 of file IRemoteCalibrator.cpp.