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
long	end
java.lang.String[]	groups Deprecated. This field is not used or displayed on the console and will be removed.
java.lang.String	id Unique identifier for this model.
long	kickoff
long	macroStep Deprecated.
java.lang.String	name Deprecated.
java.lang.String	start A starting time for model time to commence at.
long	ticks Deprecated.
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

@Deprecated
public abstract java.lang.String[] groups

Deprecated. This field is not used or displayed on the console and will be removed.

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

@Deprecated
public abstract long ticks

Deprecated.

Default number of ticks for the model to run.

Returns:

Default:

60L

end

public abstract long end

Default:

60L

kickoff

public abstract long kickoff

Default:

1L

macroStep

@Deprecated
public abstract long macroStep

Deprecated.

Number of steps occuring in a macro step

Returns:

Default:

10L