com.kuka.appframework
Annotation Type Input

@Inherited
@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface Input

Annotation for an input in the ApplicationBlock.

Inputs can be used to alter state and/or behaviour of an application block and as result the whole application at runtime.

Values for inputs can be changed via custom input view.

To create an input annotate a setter method with @Input following the rules below:

• a setter must start with word 'set' followed by any other camelCased word.
• must be void.
• the setter must be public and not static.
• the setter can only take one parameter.
• supported input types are: Integer, Double, String and Boolean.
• the setter can not be overloaded.

The name of the input is created from the name of the method: Example:

 Name of the setter method: setGripperForce 
 Name of the input: gripperForce.
 

All inputs will be set before ApplicationBlock.checkPreconditions(IChecker) and ApplicationBlock.run()

Usage example:

 @Input
 public void setForce(Integer force)
 {
    // set input value
 }
 

Optional Element Summary

String

defaultValue The defaultValue is initially assigned to this input when creating a new block instance.

defaultValue

public abstract String defaultValue

The defaultValue is initially assigned to this input when creating a new block instance.

The default value needs to be given in its String representation. Values can be converted to String by concatenating it with an empty String.

Example for Double value: @Input(defaultValue = "1.23")

Returns:

the default value

Default:

""