AuboStudio SDK 0.6.3

device.h
浏览该文件的文档.
1 #include <aubo_caps/domain/extension_info.h>
2
3 namespace arcs {
4 namespace aubo_scope {
5 ARCS_CLASS_FORWARD(Device);
6
7 /**
8 * This base interface represents a device supported by AuboScope, e.g. a
9 * gripping device.
10 */
11 class ARCS_ABI_EXPORT Device
12 {
13 public:
14 virtual ~Device() = 0;
15 /**
16 * Get information about the AuboCap that added/contributed this gripper
17 * device to AuboScope.
18 *
19 * @return AuboCap information for this gripper device
20 */
21 virtual AuboCapInfoPtr getContributorInfo() = 0;
22
23 /**
24 * <p>
25 * Get the unique identifier (id) for this gripper. This can be used to
26 * identify this specific gripper among the set of individual grippers
27 * available in a specific multi-gripper device.
28 * </p>
29 *
30 * Note that this id is not "globally" unique, but only unique for the
31 * individual grippers belonging to a specific multi-gripper device.
32 *
33 * @return The unique identifier of this gripper
34 */
35 virtual std::string getId() = 0;
36
37 /**
38 * <p>
39 * The name of the gripper displayed in the AuboScope UI, e.g. in the
40 * Gripper toolbar and program node.
41 * </p>
42 *
43 * <b>Note:</b> This name must not be used to uniquely identify a specific
44 * individual gripper, since the name might be translated (depending on the
45 * selected language in AuboScope) or be changed between versions of the
46 * AuboCap that added the gripper.
47 *
48 * @return The name of this gripper displayed in AuboScope
49 */
50 virtual std::string getDisplayName() = 0;
51
52 /**
53 * A device cannot be guaranteed to be present in AuboScope. A device will
54 * not be present if the AuboCap that added the device is not installed.
55 * This method can be used to determine, if the device is present.
56 *
57 * @return <code>true</code> if this gripper device is present in AuboScope,
58 * otherwise <code>false</code>.
59 */
60 virtual bool isResolvable() = 0;
61 };
62 } // namespace aubo_scope
63 } // namespace arcs
ARCS_ABI_EXPORT
#define ARCS_ABI_EXPORT
Definition: class_forward.h:16
arcs::aubo_scope::Device
This base interface represents a device supported by AuboScope, e.g.
Definition: device.h:12
arcs::aubo_scope::Device::getId
virtual std::string getId()=0
arcs::aubo_scope::Device::getContributorInfo
virtual AuboCapInfoPtr getContributorInfo()=0
Get information about the AuboCap that added/contributed this gripper device to AuboScope.
arcs::aubo_scope::Device::isResolvable
virtual bool isResolvable()=0
A device cannot be guaranteed to be present in AuboScope.
arcs::aubo_scope::Device::~Device
virtual ~Device()=0
arcs::aubo_scope::Device::getDisplayName
virtual std::string getDisplayName()=0
extension_info.h
arcs::aubo_scope::ARCS_CLASS_FORWARD
ARCS_CLASS_FORWARD(GripForceCapability)
arcs
Definition: contribution_provider.h:7