YARP
Yet Another Robot Platform
IHapticDevice.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2006-2020 Istituto Italiano di Tecnologia (IIT)
3  * All rights reserved.
4  *
5  * This software may be modified and distributed under the terms of the
6  * BSD-3-Clause license. See the accompanying LICENSE file for details.
7  */
8 
9 #ifndef YARP_DEV_HAPTICDEVICE_H
10 #define YARP_DEV_HAPTICDEVICE_H
11 
12 #include <yarp/sig/Vector.h>
13 #include <yarp/sig/Matrix.h>
14 
19 namespace yarp {
20  namespace dev {
21  class IHapticDevice;
22  }
23 }
24 
25 
29 class YARP_dev_API yarp::dev::IHapticDevice
30 {
31 public:
32  virtual ~IHapticDevice() { }
33 
40  virtual bool getPosition(yarp::sig::Vector &pos) = 0;
41 
48  virtual bool getOrientation(yarp::sig::Vector &rpy) = 0;
49 
56  virtual bool getButtons(yarp::sig::Vector &buttons) = 0;
57 
64  virtual bool isCartesianForceModeEnabled(bool &ret) = 0;
65 
70  virtual bool setCartesianForceMode() = 0;
71 
76  virtual bool setJointTorqueMode() = 0;
77 
87  virtual bool getMaxFeedback(yarp::sig::Vector &max) = 0;
88 
98  virtual bool setFeedback(const yarp::sig::Vector &fdbck) = 0;
99 
104  virtual bool stopFeedback() = 0;
105 
112  virtual bool setTransformation(const yarp::sig::Matrix &T) = 0;
113 
120  virtual bool getTransformation(yarp::sig::Matrix &T) = 0;
121 };
122 
123 #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:46
virtual bool setCartesianForceMode()=0
Enable Cartesian force feedback mode.
virtual ~IHapticDevice()
Definition: IHapticDevice.h:32
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.
The main, catch-all namespace for YARP.
Definition: environment.h:18
#define YARP_dev_API
Definition: api.h:19