fr.lifl.jedi.controllersCore.events
Enum ToSimulationCoreControlEvents

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

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

Lists all events that controllers of the AbstractControlGUIController class can send to the simulation core.

Version:
JEDI V 2.2
Created the 3rd 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
TO_CORE_ABORT_SIMULATION
          Event thrown to the core in order to abort the simulation.
TO_CORE_EXIT_SIMULATION
          Event thrown to the core in order to stop the simulation.
TO_CORE_INITIALIZE_SIMULATION
          Event thrown to the core in order to initialize the simulation.
TO_CORE_PAUSE_SIMULATION
          Event thrown to the core in order to pause the simulation.
TO_CORE_SIMULATION_STEP_ONCE
          Event thrown to the core in order to perform a single simulation step.
TO_CORE_START_SIMULATION
          Event thrown to the core in order to start the simulation.
TO_CORE_UNPAUSE_SIMULATION
          Event thrown to the core in order to remove the pause in the simulation.
 
Method Summary
static ToSimulationCoreControlEvents valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ToSimulationCoreControlEvents[] 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

TO_CORE_PAUSE_SIMULATION

public static final ToSimulationCoreControlEvents TO_CORE_PAUSE_SIMULATION
Event thrown to the core in order to pause the simulation.

The pause will take effect at the end of the simulation step.


TO_CORE_UNPAUSE_SIMULATION

public static final ToSimulationCoreControlEvents TO_CORE_UNPAUSE_SIMULATION
Event thrown to the core in order to remove the pause in the simulation.

The simulation will run again at most 100 milleseconds after receiving this message.


TO_CORE_START_SIMULATION

public static final ToSimulationCoreControlEvents TO_CORE_START_SIMULATION
Event thrown to the core in order to start the simulation.

The environment has to be initialized before starting the simulation.


TO_CORE_INITIALIZE_SIMULATION

public static final ToSimulationCoreControlEvents TO_CORE_INITIALIZE_SIMULATION
Event thrown to the core in order to initialize the simulation.

The simulation has not to be running. If the simulation is running, the simulation core does not take into account this event.


TO_CORE_ABORT_SIMULATION

public static final ToSimulationCoreControlEvents TO_CORE_ABORT_SIMULATION
Event thrown to the core in order to abort the simulation.

The simulation has to be running. If the simulation is not running, the simulation core does not take into account this event.


TO_CORE_SIMULATION_STEP_ONCE

public static final ToSimulationCoreControlEvents TO_CORE_SIMULATION_STEP_ONCE
Event thrown to the core in order to perform a single simulation step.

The simulation has either to be running and being paused, or to be initialized and not to be running. Otherwise, the simulation core does not take into account this event.


TO_CORE_EXIT_SIMULATION

public static final ToSimulationCoreControlEvents TO_CORE_EXIT_SIMULATION
Event thrown to the core in order to stop the simulation.

Method Detail

values

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

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

valueOf

public static ToSimulationCoreControlEvents 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