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

Class ScrewdriverProgram

java.lang.Object

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

public abstract class ScrewdriverProgram
extends Object

This abstract class represents a screwdriver program, typically defined on an external control box for the screwdriver.

Since:

1.9.0

Constructor Summary

Constructors

Constructor and Description
ScrewdriverProgram()

Method Summary

Modifier and Type	Method and Description
abstract String	getDisplayName() This method should return the name of the screwdriver program.
abstract String	getId() This method must return an identifier to uniquely identify this screwdriver program.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScrewdriverProgram

public ScrewdriverProgram()

Method Detail

getId

public abstract String getId()

This method must return an identifier to uniquely identify this screwdriver program. The identifier will be used for persistence and resolving the correct screwdriver program. Therefore the identifier must remain constant over time and versions of the screwdriver URCap.

This method must be implemented.

Returns:

a unique identifier string which will remain constant over time and versions of the screwdriver URCap.

getDisplayName

public abstract String getDisplayName()

This method should return the name of the screwdriver program. The name will be displayed in the UI, e.g. in a combo box. The name returned is allowed to change over versions of the driver URCap as well as be different depending on the current language selected in PolyScope, in case translations are supported.

This method must be implemented.

Returns:

the name of the screwdriver program to display in the UI.