cz.zcu.fav.kiv.jsim
Enum JSimSimulationMode

java.lang.Object
  java.lang.Enum<JSimSimulationMode>
      cz.zcu.fav.kiv.jsim.JSimSimulationMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<JSimSimulationMode>

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

The simulation mode defines some properties and capabilities of a simulation. Currently there are three modes available:

• Text
• Batch GUI
• Interactive GUI

Since:

J-Sim version 0.6.0

Version:

J-Sim version 0.6.0

Author:

Jarda KAČER

Enum Constant Summary

GUI_BATCH
Output goes to a GUI window.

GUI_INTERACTIVE
Output goes to a GUI window.

TEXT
Output goes to console only.

Field Summary

private java.lang.String

humanReadableDescription A human-readable description of the simulation mode.

Method Summary

java.lang.String	toString() Returns a human-readable description of the simulation mode.
static JSimSimulationMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static JSimSimulationMode[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXT

public static final JSimSimulationMode TEXT

Output goes to console only. The step() method is called explicitely from simulation code, no simulation control is available.

GUI_BATCH

public static final JSimSimulationMode GUI_BATCH

Output goes to a GUI window. The step() method is called explicitely from simulation code, no simulation control is available.

GUI_INTERACTIVE

public static final JSimSimulationMode GUI_INTERACTIVE

Output goes to a GUI window. The step() method is called upon user request.

Field Detail

humanReadableDescription

private final java.lang.String humanReadableDescription

A human-readable description of the simulation mode.

Method Detail

values

public static final JSimSimulationMode[] values()

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

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

Returns:

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

valueOf

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

toString

public java.lang.String toString()

Returns a human-readable description of the simulation mode.

Overrides:

toString in class java.lang.Enum<JSimSimulationMode>

Returns:

A human-readable description of the simulation mode.

See Also:

Enum.toString()