AuboCaps  0.6.0
arcs::aubo_scope::WidthCapability Class Referenceabstract

#include <width_capability.h>

Public Member Functions

virtual ~WidthCapability ()=default
 
virtual void updateCapability (double minWidth, double maxWidth, double defaultGripWidth, double defaultReleaseWidth)=0
 

Detailed Description

This interface represents a registered width/position capability for a gripper which supports moving to a user configurable position (open/close to a configurable width).

Through this interface, it is possible to adjust the range and default values for the width after the capability has been registered. This is typically not applicable for most grippers, but can be relevant when the range depends on another custom gripper setting (which can be configured by the user).

Definition at line 22 of file width_capability.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual void arcs::aubo_scope::WidthCapability::updateCapability ( double  minWidth,
double  maxWidth,
double  defaultGripWidth,
double  defaultReleaseWidth 
)
pure virtual

Update the range and default values for the width supported by the gripper.

Updating the range could result in an already entered value in the configuration of a gripper program node being outside the range. This will make the given program node undefined, and force the end user to adjust the value to be valid again.

Parameters
minWidthminimum width supported by the gripper
maxWidthmaximum width supported by the gripper
defaultGripWidthdefault value for the width for a grip action. This value is used for, e.g. performing a "default" grip action using the toolbar
defaultReleaseWidthdefault value for the width for a release action. This value is used for, e.g. performing a "default" release action using the toolbar
unitthe unit for all specified values, not null
Exceptions
InvalidCapabilityRangeif minWidth} > maxWidth
InvalidCapabilityRangeif defaultGripWidth or defaultReleaseWidth is outside the range defined by minWidth and maxWidth.

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