YARP
Yet Another Robot Platform
IHapticDevice.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2006-2021 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#ifndef YARP_DEV_HAPTICDEVICE_H
7#define YARP_DEV_HAPTICDEVICE_H
8
9#include <yarp/sig/Vector.h>
10#include <yarp/sig/Matrix.h>
11
16namespace yarp::dev {
17class IHapticDevice;
18}
19
20
24class YARP_dev_API yarp::dev::IHapticDevice
25{
26public:
27 virtual ~IHapticDevice() { }
28
35 virtual bool getPosition(yarp::sig::Vector &pos) = 0;
36
43 virtual bool getOrientation(yarp::sig::Vector &rpy) = 0;
44
51 virtual bool getButtons(yarp::sig::Vector &buttons) = 0;
52
59 virtual bool isCartesianForceModeEnabled(bool &ret) = 0;
60
65 virtual bool setCartesianForceMode() = 0;
66
71 virtual bool setJointTorqueMode() = 0;
72
82 virtual bool getMaxFeedback(yarp::sig::Vector &max) = 0;
83
93 virtual bool setFeedback(const yarp::sig::Vector &fdbck) = 0;
94
99 virtual bool stopFeedback() = 0;
100
107 virtual bool setTransformation(const yarp::sig::Matrix &T) = 0;
108
116};
117
118#endif
bool ret
contains the definition of a Matrix type
contains the definition of a Vector type
A class for a Matrix.
Definition: Matrix.h:39
virtual bool setCartesianForceMode()=0
Enable Cartesian force feedback mode.
virtual ~IHapticDevice()
Definition: IHapticDevice.h:27
virtual bool setJointTorqueMode()=0
Enable joint torque feedback mode.
virtual bool getMaxFeedback(yarp::sig::Vector &max)=0
Get maximum values for the feedback.
virtual bool getPosition(yarp::sig::Vector &pos)=0
Get the instantaneous position.
virtual bool getOrientation(yarp::sig::Vector &rpy)=0
Get the instantaneous orientation.
virtual bool setTransformation(const yarp::sig::Matrix &T)=0
Set the transformation matrix to be applied to position and force feedback data.
virtual bool getTransformation(yarp::sig::Matrix &T)=0
Get the current transformation matrix used to modify the position readings and force feedback.
virtual bool stopFeedback()=0
Disable force/torque feedback.
virtual bool setFeedback(const yarp::sig::Vector &fdbck)=0
Set the values for the force/torque feedback.
virtual bool getButtons(yarp::sig::Vector &buttons)=0
Get the status of the available buttons.
virtual bool isCartesianForceModeEnabled(bool &ret)=0
Query which feedback mode is active.
For streams capable of holding different kinds of content, check what they actually have.
The main, catch-all namespace for YARP.
Definition: dirs.h:16
#define YARP_dev_API
Definition: api.h:18