simudyne.core.annotations

Annotation Type Variable

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
public @interface Variable

Marks a field or method as a Variable.

A Variable is serialised as part of the model output only after setup has been run. This means that it is safe to depend upon state that is initialized as part of setup from a @Variable method (such as an AgentSystem).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	group Specify the grouping of the this variable.
boolean	initializable Specify if the variable can be assigned to before setup.
java.lang.String	name Specify the human-friendly name for this variable.

Element Detail

name

public abstract java.lang.String name

Specify the human-friendly name for this variable. If not set, the name of the field or method will be used.

Default:

""

group

public abstract long group

Specify the grouping of the this variable. If not set defaults to a 'non group'

Default:

9223372036854775807L

initializable

public abstract boolean initializable

Specify if the variable can be assigned to before setup.

This setting will currently be ignored for methods marked as Variable.

Default:

false