bio.singa.simulation.model.modules.concentration

Enum ModuleState

java.lang.Object

java.lang.Enum<ModuleState>

bio.singa.simulation.model.modules.concentration.ModuleState

All Implemented Interfaces:

Serializable, Comparable<ModuleState>

public enum ModuleState
extends Enum<ModuleState>

The state of the module is used to schedule the processing of modules in the UpdateScheduler.

Author:

cl

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERRORED Some error has occurred during calculation.
PENDING Currently unprocessed module.
REQUIRING_RECALCULATION The calculation has finished but the numerical error was too large (set by UpdateScheduler.setRecalculationCutoff(double)).
SUCCEEDED Calculation has completed with numerical error below the given threshold (set by UpdateScheduler.setRecalculationCutoff(double)).
SUCCEEDED_WITH_PENDING_CHANGES The module has completed successfully but contains some changes to the simulation that should be applied at the very end of the time step.

Method Summary

Modifier and Type	Method and Description
static ModuleState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ModuleState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PENDING

public static final ModuleState PENDING

Currently unprocessed module.

SUCCEEDED

public static final ModuleState SUCCEEDED

Calculation has completed with numerical error below the given threshold (set by UpdateScheduler.setRecalculationCutoff(double)). Updates are not yet applied.

SUCCEEDED_WITH_PENDING_CHANGES

public static final ModuleState SUCCEEDED_WITH_PENDING_CHANGES

The module has completed successfully but contains some changes to the simulation that should be applied at the very end of the time step.

REQUIRING_RECALCULATION

public static final ModuleState REQUIRING_RECALCULATION

The calculation has finished but the numerical error was too large (set by UpdateScheduler.setRecalculationCutoff(double)).

ERRORED

public static final ModuleState ERRORED

Some error has occurred during calculation.

Method Detail

values

public static ModuleState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModuleState c : ModuleState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModuleState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null