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

Interface ScrewdriverProgramListProvider

public interface ScrewdriverProgramListProvider

This interface must be implemented by the screwdriver URCap to register the program selection capability. The implementation is responsible for providing PolyScope the list of programs (typically defined on an external control box for the screwdriver).

Pass the implementation of this interface to the method ScrewdriverCapabilities.registerProgramSelectionCapability(ScrewdriverProgramListProvider, ScriptCodeGenerator) when registering the program selection capability.

Since:

1.9.0

Method Summary

Modifier and Type	Method and Description
void	populateList(ScrewdriverProgramList programList) When this method is called (by PolyScope), the provided list must be populated with the current list of screwdriver programs (typically defined on an external control box for the screwdriver).

Method Detail

populateList

void populateList(ScrewdriverProgramList programList)

When this method is called (by PolyScope), the provided list must be populated with the current list of screwdriver programs (typically defined on an external control box for the screwdriver).

This method is called every time the list of screwdriver programs needs to be displayed in PolyScope. Thus the transfer of the list should be performant, so this function call is completed as fast as possible. With every method call, a new empty instance of the list is provided. This instance must be used to add the programs, so do not store a reference to the list.

Parameters:

programList - the list to add the screwdriver programs to. The list is initially empty.