fr.lifl.jedi.controllersCore.simulationRun
Enum SimulationCoreStates

java.lang.Object
  extended by java.lang.Enum<SimulationCoreStates>
      extended by fr.lifl.jedi.controllersCore.simulationRun.SimulationCoreStates
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SimulationCoreStates>

public enum SimulationCoreStates
extends java.lang.Enum<SimulationCoreStates>

The enumeration of all the states in which the simulation core can be in.

Version:
JEDI V 2.2
Created the 2nd april 2009
Modified the 5th may 2009
Author:
Yoann Kubera
SMAC Team (Systèmes Multi-Agents et Comportement)
LIFL (Laboratoire d'Informatique Fondamentale de Lille)
University of Lille, France

Enum Constant Summary
ABORTED_STATE
          State of the simulation core when the simulation core waits for all registered GUI controllers to finish their processing after the abortion of the simulation.
ENDED_STATE
          State of the simulation core when the simulation core waits for all registered GUI controllers to finish their processing after the end of the simulation.
INITIALIZED_STATE
          State of the simulation core when the gui have updated after the environments initialization.
INITIALIZING_STATE
          State of the simulation core when the initialization of the environment is still in progress.
PAUSED_STATE
          State of the simulation core when the simulation is paused.
RUNNING_A_SIMULATION_STEP_STATE
          State of the simulation core when a simulation step is being performed.
VOID_STATE
          State of the simulation core when the initialization was not made even once.
WAITING_FOR_GUI_AFTER_A_STEP_STATE
          State of the simulation core when a simulation step ended, and the simulation core wais for all GUI registered to it to notify the end of their update
WAITING_FOR_GUI_AFTER_INITIALIZATION_STATE
          State of the simulation core when the initialization of the environment is finished, and the simulation core waits for all GUI registered to it to notify the end of their update.
WAITING_FOR_GUI_AFTER_SIMULATION_ABORTION_STATE
          State of the simulation core when the simulation is aborted -- i.e.
WAITING_FOR_GUI_AFTER_SIMULATION_END_STATE
          State of the simulation core when the last simulation step ended -- i.e.
WAITING_FOR_GUI_BEFORE_CLOSING_STATE
          State of the simulation core when the simulation is about to be closed : the simulation core waits for all GUI registered to it to notify the end of their processing before exiting.
 
Method Summary
static SimulationCoreStates valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SimulationCoreStates[] 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

VOID_STATE

public static final SimulationCoreStates VOID_STATE
State of the simulation core when the initialization was not made even once.


INITIALIZING_STATE

public static final SimulationCoreStates INITIALIZING_STATE
State of the simulation core when the initialization of the environment is still in progress.


WAITING_FOR_GUI_AFTER_INITIALIZATION_STATE

public static final SimulationCoreStates WAITING_FOR_GUI_AFTER_INITIALIZATION_STATE
State of the simulation core when the initialization of the environment is finished, and the simulation core waits for all GUI registered to it to notify the end of their update.


INITIALIZED_STATE

public static final SimulationCoreStates INITIALIZED_STATE
State of the simulation core when the gui have updated after the environments initialization.


RUNNING_A_SIMULATION_STEP_STATE

public static final SimulationCoreStates RUNNING_A_SIMULATION_STEP_STATE
State of the simulation core when a simulation step is being performed.


WAITING_FOR_GUI_AFTER_A_STEP_STATE

public static final SimulationCoreStates WAITING_FOR_GUI_AFTER_A_STEP_STATE
State of the simulation core when a simulation step ended, and the simulation core wais for all GUI registered to it to notify the end of their update


PAUSED_STATE

public static final SimulationCoreStates PAUSED_STATE
State of the simulation core when the simulation is paused.


ENDED_STATE

public static final SimulationCoreStates ENDED_STATE
State of the simulation core when the simulation core waits for all registered GUI controllers to finish their processing after the end of the simulation.


WAITING_FOR_GUI_AFTER_SIMULATION_END_STATE

public static final SimulationCoreStates WAITING_FOR_GUI_AFTER_SIMULATION_END_STATE
State of the simulation core when the last simulation step ended -- i.e. the simulation has reached its ending condition : the simulation core waits for all GUI registered to it to notify the end of their processing.


ABORTED_STATE

public static final SimulationCoreStates ABORTED_STATE
State of the simulation core when the simulation core waits for all registered GUI controllers to finish their processing after the abortion of the simulation.


WAITING_FOR_GUI_AFTER_SIMULATION_ABORTION_STATE

public static final SimulationCoreStates WAITING_FOR_GUI_AFTER_SIMULATION_ABORTION_STATE
State of the simulation core when the simulation is aborted -- i.e. the control gui asked the simulation to abort : the simulation core waits for all GUI registered to it to notify the end of their processing.


WAITING_FOR_GUI_BEFORE_CLOSING_STATE

public static final SimulationCoreStates WAITING_FOR_GUI_BEFORE_CLOSING_STATE
State of the simulation core when the simulation is about to be closed : the simulation core waits for all GUI registered to it to notify the end of their processing before exiting.

Method Detail

values

public static SimulationCoreStates[] 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 (SimulationCoreStates c : SimulationCoreStates.values())
    System.out.println(c);

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

valueOf

public static SimulationCoreStates valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null