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

Interface ScrewdriverProgramList

public interface ScrewdriverProgramList

This interface represents the list of programs, typically defined on an external control box for the screwdriver.

Use the interface to provide the list of screw driver programs to PolyScope.

Since:

1.9.0

Method Summary

Modifier and Type	Method and Description
void	add(ScrewdriverProgram screwdriverProgram) Add a screwdriver program to the list of programs.
void	addAll(List<ScrewdriverProgram> screwdriverProgramList) Add a list of screwdriver programs to the list of programs.

Method Detail

add

void add(ScrewdriverProgram screwdriverProgram)

Add a screwdriver program to the list of programs.

Parameters:

screwdriverProgram - program to add, not null

Throws:

DuplicateScrewdriverProgramID - if the ids of the screwdriver programs (returned by the method ScrewdriverProgram.getId()) are not unique.

NameOfScrewdriverProgramCannotBeNullOrEmpty - if the display name of a program (returned by the method ScrewdriverProgram.getDisplayName()) is null or an empty string.

addAll

void addAll(List<ScrewdriverProgram> screwdriverProgramList)

Add a list of screwdriver programs to the list of programs.

Parameters:

screwdriverProgramList - list of programs to add, not null

Throws:

DuplicateScrewdriverProgramID - if the ids of the screwdriver programs (returned by the method ScrewdriverProgram.getId()) are not unique.

NameOfScrewdriverProgramCannotBeNullOrEmpty - if the display name of a program (returned by the method ScrewdriverProgram.getDisplayName()) is null or an empty string.