velox.api.layer1.simplified

Annotation Type Parameter

@Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface Parameter

The class is used to annotate fields the user wants to be shown in his Strategy GUI. Numeric object types are accepted (Byte, Short, Integer, Long, Float, Double) for annotated fields as long as String or Boolean or Color. Any field must be initialized. A spinner gets created for a numeric type. The user should specify step, minimum and maximum values for the spinner. Otherwise, 1 will be used as the default step value, 0 as minimum value, and maximal field type value as maximum value. Step, minimum and maximum values for any other field type should not be specified. Even if specified, they will be ignored. A text field will be created for a String type field, a checkbox for Boolean, and a color interface for Color.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	name name displayed in UI

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
double	maximum maximum value for a numeric field type only
double	minimum minimum value for a numeric field type only
boolean	reloadOnChange if true, the instrument gets reloaded after the parameter has been changed
double	step step value for a numeric field type only

Element Detail

name

public abstract java.lang.String name

name displayed in UI

step

public abstract double step

step value for a numeric field type only

Default:

1.0

minimum

public abstract double minimum

minimum value for a numeric field type only

Default:

0d/0d

maximum

public abstract double maximum

maximum value for a numeric field type only

Default:

0d/0d

reloadOnChange

public abstract boolean reloadOnChange

if true, the instrument gets reloaded after the parameter has been changed

Default:

true