com.ur.urcap.api.contribution.driver.screwdriver

Interface ScrewdriverParameters

public interface ScrewdriverParameters

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

Since:

1.9.0

Method Summary

Modifier and Type	Method and Description
ScrewdriverOperationType	getScrewdriverOperationType() Get the selected screwdriver operation type.
ScrewdriverProgram	getScrewdriverProgram() Get the selected screwdriver program to be used for the screwdriver operation.

Method Detail

getScrewdriverProgram

ScrewdriverProgram getScrewdriverProgram()

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 ScrewdriverCapabilities.registerProgramSelectionCapability(ScrewdriverProgramListProvider, ScriptCodeGenerator)).

Returns:

The selected screwdriver program to use for the operation.

Throws:

UnsupportedOperationException - if the screwdriver has not registered the program selection capability

getScrewdriverOperationType

ScrewdriverOperationType getScrewdriverOperationType()

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.

Throws:

UnsupportedOperationException - if the screwdriver has not registered the operation type capability