YARP
Yet Another Robot Platform
IRemoteCalibrator.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
3  * Copyright (C) 2006-2010 RobotCub Consortium
4  * All rights reserved.
5  *
6  * This software may be modified and distributed under the terms of the
7  * BSD-3-Clause license. See the accompanying LICENSE file for details.
8  */
9 
10 #ifndef YARP_DEV_REMOTECALIBRATOR_H
11 #define YARP_DEV_REMOTECALIBRATOR_H
12 
13 #include <yarp/dev/DeviceDriver.h>
14 
15 namespace yarp {
16 namespace dev {
17 
30 {
31 private:
32  yarp::dev::IRemoteCalibrator* _remoteCalibrator;
33 
34 public:
36 
37  virtual ~IRemoteCalibrator() = default;
38 
48  virtual bool setCalibratorDevice(yarp::dev::IRemoteCalibrator* dev);
49 
54  virtual yarp::dev::IRemoteCalibrator* getCalibratorDevice();
55 
60  virtual bool isCalibratorDevicePresent(bool* isCalib);
61 
65  virtual void releaseCalibratorDevice();
66 
72  virtual bool calibrateSingleJoint(int j) = 0;
73 
78  virtual bool calibrateWholePart() = 0;
79 
85  virtual bool homingSingleJoint(int j) = 0;
86 
91  virtual bool homingWholePart() = 0;
92 
97  virtual bool parkSingleJoint(int j, bool _wait = true) = 0;
98 
103  virtual bool parkWholePart() = 0;
104 
109  virtual bool quitCalibrate() = 0;
110 
115  virtual bool quitPark() = 0;
116 };
117 
118 } // namespace dev
119 } // namespace yarp
120 
121 #endif // YARP_DEV_REMOTECALIBRATOR_H
yarp::dev::IRemoteCalibrator::quitCalibrate
virtual bool quitCalibrate()=0
quitCalibrate: interrupt the calibration procedure
yarp::dev::IRemoteCalibrator::homingWholePart
virtual bool homingWholePart()=0
homingWholePart: call the homing procedure for a the whole part/device
yarp::dev::IRemoteCalibrator::homingSingleJoint
virtual bool homingSingleJoint(int j)=0
homingSingleJoint: call the homing procedure for a single joint
yarp::dev::IRemoteCalibrator::calibrateWholePart
virtual bool calibrateWholePart()=0
calibrateWholePart: call the procedure for calibrating the whole device
yarp::dev::IRemoteCalibrator::parkSingleJoint
virtual bool parkSingleJoint(int j, bool _wait=true)=0
parkSingleJoint(): start the parking procedure for the single joint
YARP_dev_API
#define YARP_dev_API
Definition: api.h:19
yarp::dev::IRemoteCalibrator::calibrateSingleJoint
virtual bool calibrateSingleJoint(int j)=0
calibrateSingleJoint: call the calibration procedure for the single joint
yarp
The main, catch-all namespace for YARP.
Definition: environment.h:18
yarp::dev::IRemoteCalibrator::parkWholePart
virtual bool parkWholePart()=0
parkWholePart: start the parking procedure for the whole part
yarp::dev::IRemoteCalibrator::~IRemoteCalibrator
virtual ~IRemoteCalibrator()=default
yarp::dev::IRemoteCalibrator
IRemoteCalibrator interface is meant to remotize the access of the calibration device in order to all...
Definition: IRemoteCalibrator.h:30
yarp::dev::IRemoteCalibrator::quitPark
virtual bool quitPark()=0
quitPark: interrupt the park procedure
DeviceDriver.h