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

Interface ProgramSelectionParameters

public interface ProgramSelectionParameters

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

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

Method Summary

Modifier and Type	Method and Description
ScrewdriverOperationType	getScrewdriverOperationType()
ScrewdriverProgram	getScrewdriverProgram()

Method Detail

getScrewdriverProgram

ScrewdriverProgram getScrewdriverProgram()

Returns:

The selected screwdriver program to use for the operation.

Throws:

UnsupportedOperationException - if the screwdriver has not registered this capability

getScrewdriverOperationType

ScrewdriverOperationType getScrewdriverOperationType()

Returns:

The operation type selected by the end user.

Throws:

UnsupportedOperationException - if the screwdriver has not registered this capability