simudyne.core.annotations

Annotation Type ModelSettings

@Target(value={TYPE,FIELD})
 @Retention(value=RUNTIME)
public @interface ModelSettings

Specify the settings for a model.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String[]	groups Array of group names associated with group long in VariableTypes.
java.lang.String	id Unique identifier for this model.
long	macroStep Number of steps occuring in a macro step
java.lang.String	name Deprecated.
java.lang.String	start A starting time for model time to commence at.
long	ticks Default number of ticks for the model to run.
long	timeStep Number of timeUnits that occur between calculate() calls.
java.lang.String	timeUnit The base timeUnit for timeSteps to occur in.

Element Detail

name

@Deprecated
public abstract java.lang.String name

Deprecated.

A human friendly name for the model.

Default:

"New Model"

id

public abstract java.lang.String id

Unique identifier for this model.

Default:

"new_model"

groups

public abstract java.lang.String[] groups

Array of group names associated with group long in VariableTypes. Follows convention of lowest order to assign.

Default:

{}

start

public abstract java.lang.String start

A starting time for model time to commence at.

Default:

"2018-01-01T00:00:00Z"

timeStep

public abstract long timeStep

Number of timeUnits that occur between calculate() calls.

Default:

1L

timeUnit

public abstract java.lang.String timeUnit

The base timeUnit for timeSteps to occur in.

Default:

"MONTHS"

ticks

public abstract long ticks

Default number of ticks for the model to run.

Default:

60L

macroStep

public abstract long macroStep

Number of steps occuring in a macro step

Default:

10L