arcs::aubo_scope::Device Class Reference

This base interface represents a device supported by AuboScope, e.g. More...

#include <device.h>

Inheritance diagram for arcs::aubo_scope::Device:

Public Member Functions
virtual	~Device ()=0
virtual AuboCapInfoPtr	getContributorInfo ()=0
	Get information about the AuboCap that added/contributed this gripper device to AuboScope. More...
virtual std::string	getId ()=0
virtual std::string	getDisplayName ()=0
virtual bool	isResolvable ()=0
	A device cannot be guaranteed to be present in AuboScope. More...

Detailed Description

This base interface represents a device supported by AuboScope, e.g.

a gripping device.

Definition at line 11 of file device.h.

Constructor & Destructor Documentation

virtual arcs::aubo_scope::Device::~Device ( )

pure virtual

Member Function Documentation

virtual AuboCapInfoPtr arcs::aubo_scope::Device::getContributorInfo ( )

pure virtual

Get information about the AuboCap that added/contributed this gripper device to AuboScope.

Returns

AuboCap information for this gripper device

virtual std::string arcs::aubo_scope::Device::getDisplayName ( )

pure virtual

The name of the gripper displayed in the AuboScope UI, e.g. in the Gripper toolbar and program node.

Note: This name must not be used to uniquely identify a specific individual gripper, since the name might be translated (depending on the selected language in AuboScope) or be changed between versions of the AuboCap that added the gripper.

Returns

The name of this gripper displayed in AuboScope

virtual std::string arcs::aubo_scope::Device::getId ( )

pure virtual

Get the unique identifier (id) for this gripper. This can be used to identify this specific gripper among the set of individual grippers available in a specific multi-gripper device.

Note that this id is not "globally" unique, but only unique for the individual grippers belonging to a specific multi-gripper device.

Returns

The unique identifier of this gripper

virtual bool arcs::aubo_scope::Device::isResolvable ( )

pure virtual

A device cannot be guaranteed to be present in AuboScope.

A device will not be present if the AuboCap that added the device is not installed. This method can be used to determine, if the device is present.

Returns

true if this gripper device is present in AuboScope, otherwise false.

---

The documentation for this class was generated from the following file:

• include/aubo_caps/domain/device/device.h