AuboCaps  0.6.0
arcs::aubo_scope::ProgramSelectionParameters Class Referenceabstract

#include <screw_driver_configuration.h>

Public Member Functions

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

Detailed Description

This interface provides parameters relevant for generating script code for the Program Selection capability (registered using ScriptCodeGenerator)).

These parameters are passed when AuboScope calls the implementation of the ScriptCodeGenerator#generateScript(ScriptWriter, Object) method responsible for the generating the script code.

Definition at line 24 of file screw_driver_configuration.h.

Constructor & Destructor Documentation

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

Member Function Documentation

virtual ScrewdriverOperationType arcs::aubo_scope::ProgramSelectionParameters::getScrewdriverOperationType ( )
pure virtual
Returns
The operation type selected by the end user.
Exceptions
UnsupportedOperationExceptionif the screwdriver has not registered this capability
virtual ScrewdriverProgram arcs::aubo_scope::ProgramSelectionParameters::getScrewdriverProgram ( )
pure virtual
Returns
The selected screwdriver program to use for the operation.
Exceptions
UnsupportedOperationExceptionif the screwdriver has not registered this capability

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