AuboCaps  0.6.0
arcs::aubo_scope::ScrewdriverParameters Class Referenceabstract

This interface represents parameters for a screwdriver operation defined/configured by the end user. More...

#include <screw_driver_parameters.h>

Public Member Functions

virtual ~ScrewdriverParameters ()=default
 
virtual ScrewdriverProgram getScrewdriverProgram ()=0
 
virtual ScrewdriverOperationType getScrewdriverOperationType ()=0
 

Detailed Description

This interface represents parameters for a screwdriver operation defined/configured by the end user.

Definition at line 77 of file screw_driver_parameters.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual ScrewdriverOperationType arcs::aubo_scope::ScrewdriverParameters::getScrewdriverOperationType ( )
pure virtual

Get the selected screwdriver operation type.

This is only valid, if the operation type capability has been registered (using the method ScrewdriverCapabilities#registerOperationTypeCapability()).

Returns
The operation type selected by the user.
Exceptions
UnsupportedOperationExceptionif the screwdriver has not registered the operation type capability
virtual ScrewdriverProgram arcs::aubo_scope::ScrewdriverParameters::getScrewdriverProgram ( )
pure virtual

Get the selected screwdriver program to be used for the screwdriver operation.

This is only valid, if the program selection capability has been registered (using the method ScriptCodeGenerator)).

Returns
The selected screwdriver program to use for the operation.
Exceptions
UnsupportedOperationExceptionif the screwdriver has not registered the program selection capability

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