YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
IJointBrake.h
Go to the documentation of this file.
1/*
2 * SPDX-FileCopyrightText: 2025-2025 Istituto Italiano di Tecnologia (IIT)
3 * SPDX-License-Identifier: BSD-3-Clause
4 */
5
6#ifndef YARP_DEV_IJOINTBRAKE_H
7#define YARP_DEV_IJOINTBRAKE_H
8
9#include <yarp/dev/api.h>
11
12namespace yarp::dev {
13class IJointBrakeRaw;
14class IJointBrake;
15}
16
23{
24public:
25 virtual ~IJointBrake(){}
26
33 virtual yarp::dev::ReturnValue isJointBraked(int j, bool& braked) const =0;
34
41 virtual yarp::dev::ReturnValue setManualBrakeActive(int j, bool active) =0;
42
51 virtual yarp::dev::ReturnValue setAutoBrakeEnabled(int j, bool enabled) =0;
52
59 virtual yarp::dev::ReturnValue getAutoBrakeEnabled(int j, bool& enabled) const =0;
60};
61
62
70{
71public:
72 virtual ~IJointBrakeRaw(){}
73 virtual yarp::dev::ReturnValue isJointBrakedRaw(int j, bool& braked) const =0;
74 virtual yarp::dev::ReturnValue setManualBrakeActiveRaw(int j, bool active) =0;
75 virtual yarp::dev::ReturnValue setAutoBrakeEnabledRaw(int j, bool enabled) =0;
76 virtual yarp::dev::ReturnValue getAutoBrakeEnabledRaw(int j, bool& enabled) const =0;
77};
78
79#endif // YARP_DEV_IJOINTBRAKE_H
Interface for controlling a joint equipped with brakes (hardware or simulated).
Definition IJointBrake.h:70
virtual yarp::dev::ReturnValue setManualBrakeActiveRaw(int j, bool active)=0
virtual yarp::dev::ReturnValue isJointBrakedRaw(int j, bool &braked) const =0
virtual yarp::dev::ReturnValue getAutoBrakeEnabledRaw(int j, bool &enabled) const =0
virtual yarp::dev::ReturnValue setAutoBrakeEnabledRaw(int j, bool enabled)=0
Interface for controlling a joint equipped with brakes (hardware or simulated).
Definition IJointBrake.h:23
virtual yarp::dev::ReturnValue setAutoBrakeEnabled(int j, bool enabled)=0
Enables/Disables the automatic joint brake.
virtual yarp::dev::ReturnValue isJointBraked(int j, bool &braked) const =0
Check is the joint brake is currently active.
virtual yarp::dev::ReturnValue getAutoBrakeEnabled(int j, bool &enabled) const =0
checks if the automatic joint brake mode is enabled or disabled.
virtual yarp::dev::ReturnValue setManualBrakeActive(int j, bool active)=0
Enables/Disables manually the joint brake.
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