YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
IControlCalibration.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_ICONTROLCALIBRATION_H
8#define YARP_DEV_ICONTROLCALIBRATION_H
9
10#include <yarp/os/Vocab.h>
11#include <yarp/dev/api.h>
12#include <yarp/dev/CalibratorInterfaces.h> // ICalibrator
14
15namespace yarp::dev {
16class IControlCalibrationRaw;
17class IControlCalibration;
18struct CalibrationParameters;
19} // namespace yarp::dev
20
22{
23 unsigned int type;
24 double param1;
25 double param2;
26 double param3;
27 double param4;
28 double param5;
29 double paramZero;
30 CalibrationParameters() { type = 0; param1 = 0; param2 = 0; param3 = 0; param4 = 0; param5 = 0; paramZero = 0; }
31};
32
39{
40public:
46
53
59 virtual yarp::dev::ReturnValue calibrateAxisWithParamsRaw(int axis, unsigned int type, double p1, double p2, double p3)=0;
60
67
68};
69
76{
77private:
78 ICalibrator *calibrator;
79
80public:
86
92 virtual yarp::dev::ReturnValue calibrateAxisWithParams(int axis, unsigned int type, double p1, double p2, double p3)=0;
93
100
107
113 virtual yarp::dev::ReturnValue setCalibrator(ICalibrator *c);
114
121 virtual yarp::dev::ReturnValue calibrateRobot();
122
123 virtual yarp::dev::ReturnValue park(bool wait=true);
124
125 /* Abort calibration, force the function calibrate() to return.*/
126 virtual yarp::dev::ReturnValue abortCalibration();
127
128 /* Abort parking, force the function park() to return.*/
129 virtual yarp::dev::ReturnValue abortPark();
130};
131
132
133/* Vocabs representing the above interfaces */
134
141
142#endif // YARP_DEV_ICONTROLCALIBRATION_H
constexpr yarp::conf::vocab32_t VOCAB_ABORTCALIB
constexpr yarp::conf::vocab32_t VOCAB_ABORTPARK
constexpr yarp::conf::vocab32_t VOCAB_CALIBRATE_DONE
constexpr yarp::conf::vocab32_t VOCAB_CALIBRATE
constexpr yarp::conf::vocab32_t VOCAB_CALIBRATE_CHANNEL
constexpr yarp::conf::vocab32_t VOCAB_PARK
Interface for a calibrator device.
Definition ICalibrator.h:22
Interface for control devices, calibration commands.
virtual yarp::dev::ReturnValue calibrationDoneRaw(int j)=0
Check if the calibration is terminated, on a particular joint.
virtual ~IControlCalibrationRaw()
Destructor.
virtual yarp::dev::ReturnValue calibrateAxisWithParamsRaw(int axis, unsigned int type, double p1, double p2, double p3)=0
Start calibration, this method is very often platform specific.
virtual yarp::dev::ReturnValue setCalibrationParametersRaw(int axis, const CalibrationParameters &params)=0
Start calibration, this method is very often platform specific.
Interface for control devices, calibration commands.
virtual yarp::dev::ReturnValue calibrationDone(int j)=0
Check if the calibration is terminated, on a particular joint.
virtual yarp::dev::ReturnValue calibrateAxisWithParams(int axis, unsigned int type, double p1, double p2, double p3)=0
Start calibration, this method is very often platform specific.
virtual ~IControlCalibration()
Destructor.
virtual yarp::dev::ReturnValue setCalibrationParameters(int axis, const CalibrationParameters &params)=0
Start calibration, this method is very often platform specific.
std::int32_t vocab32_t
Definition numeric.h:78
For streams capable of holding different kinds of content, check what they actually have.
constexpr yarp::conf::vocab32_t createVocab32(char a, char b=0, char c=0, char d=0)
Create a vocab from chars.
Definition Vocab32.h:27
The main, catch-all namespace for YARP.
Definition dirs.h:16
#define YARP_dev_API
Definition api.h:18