YARP
Yet Another Robot Platform
IRemoteCalibrator.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3  * SPDX-FileCopyrightText: 2006-2010 RobotCub Consortium
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef YARP_DEV_REMOTECALIBRATOR_H
8 #define YARP_DEV_REMOTECALIBRATOR_H
9 
10 #include <yarp/dev/DeviceDriver.h>
11 
12 namespace yarp {
13 namespace dev {
14 
27 {
28 private:
29  yarp::dev::IRemoteCalibrator* _remoteCalibrator;
30 
31 public:
33 
34  virtual ~IRemoteCalibrator() = default;
35 
45  virtual bool setCalibratorDevice(yarp::dev::IRemoteCalibrator* dev);
46 
51  virtual yarp::dev::IRemoteCalibrator* getCalibratorDevice();
52 
57  virtual bool isCalibratorDevicePresent(bool* isCalib);
58 
62  virtual void releaseCalibratorDevice();
63 
69  virtual bool calibrateSingleJoint(int j) = 0;
70 
75  virtual bool calibrateWholePart() = 0;
76 
82  virtual bool homingSingleJoint(int j) = 0;
83 
88  virtual bool homingWholePart() = 0;
89 
94  virtual bool parkSingleJoint(int j, bool _wait = true) = 0;
95 
100  virtual bool parkWholePart() = 0;
101 
106  virtual bool quitCalibrate() = 0;
107 
112  virtual bool quitPark() = 0;
113 };
114 
115 } // namespace dev
116 } // namespace yarp
117 
118 #endif // YARP_DEV_REMOTECALIBRATOR_H
IRemoteCalibrator interface is meant to remotize the access of the calibration device in order to all...
virtual bool parkWholePart()=0
parkWholePart: start the parking procedure for the whole part
virtual bool homingSingleJoint(int j)=0
homingSingleJoint: call the homing procedure for a single joint
virtual bool homingWholePart()=0
homingWholePart: call the homing procedure for a the whole part/device
virtual bool quitPark()=0
quitPark: interrupt the park procedure
virtual bool parkSingleJoint(int j, bool _wait=true)=0
parkSingleJoint(): start the parking procedure for the single joint
virtual bool calibrateSingleJoint(int j)=0
calibrateSingleJoint: call the calibration procedure for the single joint
virtual bool calibrateWholePart()=0
calibrateWholePart: call the procedure for calibrating the whole device
virtual bool quitCalibrate()=0
quitCalibrate: interrupt the calibration procedure
virtual ~IRemoteCalibrator()=default
The main, catch-all namespace for YARP.
Definition: dirs.h:16
#define YARP_dev_API
Definition: api.h:18