AuboCaps  0.6.0
arcs::aubo_scope::RegisteredCapabilities Class Referenceabstract

#include <registered_cpabilities.h>

Public Member Functions

virtual ~RegisteredCapabilities ()=default
 
virtual WidthCapabilityPtr getWidthCapability ()=0
 
virtual GripForceCapabilityPtr getGripForceCapability ()=0
 
virtual SpeedCapabilityPtr getSpeedCapability ()=0
 
virtual GripVacuumCapabilityPtr getGripVacuumCapability ()=0
 

Detailed Description

Each of the individual grippers/zones available in a multi-gripper device supports all capabilities that has been registered, i.e. all the individual grippers have the exact same set of capabilities. This interface gives access to all registered capabilities, such as the width capability (see WidthCapability), speed capability (see SpeedCapability), etc. This enables dynamic adjustment of capability properties, including the value range and default values, exclusively per individual gripper (independently of the other grippers).

This interface is only relevant if the multi-gripper capability has been registered (using the method double, double, double, Length.Unit)).

Each capability must be registered using the GripperCapabilities interface (when GripperAPIProvider) is called) before they can be accessed using this interface.

NOTE: If an update of the properties of a capability needs to apply for all individual grippers, it is more convenient to perform the adjustment simultaneously for all grippers using the capability instance (e.g. WidthCapability) returned when the capability was registered (with the GripperCapabilities interface).

Definition at line 49 of file registered_cpabilities.h.

Constructor & Destructor Documentation

virtual arcs::aubo_scope::RegisteredCapabilities::~RegisteredCapabilities ( )
virtualdefault

Member Function Documentation

virtual GripForceCapabilityPtr arcs::aubo_scope::RegisteredCapabilities::getGripForceCapability ( )
pure virtual

Access the grip force capability interface which allows for dynamic adjustments of the capability properties exclusively for this specific individual gripper (independently of the other grippers), including the value range and default value.

This is only valid, if the force capability has been registered (using the method double, double, Force.Unit)).

Returns
The grip force capability for this individual gripper
Exceptions
UnsupportedOperationExceptionif the gripper has not registered the force capability
virtual GripVacuumCapabilityPtr arcs::aubo_scope::RegisteredCapabilities::getGripVacuumCapability ( )
pure virtual

Access the grip vacuum capability interface which allows for dynamic adjustments of the capability properties exclusively for this specific individual gripper (independently of the other grippers), including the value range and default value.

This is only valid, if the vacuum capability has been registered (using the method double, double, Pressure.Unit)).

Returns
The grip vacuum capability for this individual gripper
Exceptions
UnsupportedOperationExceptionif the gripper has not registered the vacuum capability
virtual SpeedCapabilityPtr arcs::aubo_scope::RegisteredCapabilities::getSpeedCapability ( )
pure virtual

Access the speed capability interface which allows for dynamic adjustments of the capability properties exclusively for this specific individual gripper (independently of the other grippers), including the value range and default value.

This is only valid, if the speed capability has been registered (using the method double, double, double, Speed.Unit)).

Returns
The speed capability for this individual gripper
Exceptions
UnsupportedOperationExceptionif the gripper has not registered the speed capability
virtual WidthCapabilityPtr arcs::aubo_scope::RegisteredCapabilities::getWidthCapability ( )
pure virtual

Access the width capability interface which allows for dynamic adjustments of the capability properties exclusively for this specific individual gripper (independently of the other grippers), including the value range and default value.

This is only valid, if the width capability has been registered (using the method double, double, double, Length.Unit)).

Returns
The width capability for this individual gripper
Exceptions
UnsupportedOperationExceptionif the gripper has not registered the width capability

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