org.jlab.coda.emu.support.codaComponent

Enum CODAState

java.lang.Object

java.lang.Enum<CODAState>

org.jlab.coda.emu.support.codaComponent.CODAState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CODAState>, CODAStateIF

public enum CODAState
extends java.lang.Enum<CODAState>
implements CODAStateIF

This class is an enum which lists all the possible CODA Emu state-machine states. Each of these states has a corresponding set of transitions that are allowed CODATransition. This is the only class that implements the CODAStateIF interface.

                 *****************
                 * State Machine *
                 *****************
 ____________________________________________________
   INTERMEDIATE  |                 |   INTERMEDIATE
      STATE      |      STATE      |      STATE
 ________________|_________________|_________________

                               (if reset from ERROR or BOOTED)
                  <- BOOTED <-----------------------------,
                 |                                        |
   CONFIGURING   |                                        |
                 |               <------------------------|
                 '-> CONFIGURED ->----------------------->|
                  <-                                      ^
                 |                                        |
   DOWNLOADING   |                                        |
                 |                                        |
                 '-> DOWNLOADED ->----------------------->|
                  <-            <-,<----------,           ^
                 |                ^           ^           |
                 |                |           |           |
   PRESTARTING   |                | ENDING    | ENDING    | reset
                 |                |           |           |
                 '-> PAUSED -----> -----------|---------->|
                  <-                          |           ^
                 |                            |           |
      GOING      |                            |           |
                 |                            |           |
                 '->  ACTIVE  --------------->'---------->'

 __________________________________________________________________

  NOTE: DOWNLOADED can always do a download,
        CONFIGURED can always do a configure, and
        RESET goes from any state to CONFIGURED (to BOOTED if in ERROR or BOOTED state)

 

Author:

heyes, timmer

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVATING Activating state - in the process of becoming active.
ACTIVE ACTIVE state.
BOOTED BOOTED state.
CONFIGURED CONFIGURED state.
CONFIGURING Configuring state - in the process of configuring.
DOWNLOADED DOWNLOADED state (same as ENDED).
DOWNLOADING Downloading state - in the process of downloading.
ENDING Ending state - got END command but no END event yet.
ERROR ERROR state.
PAUSED PAUSED state (same as PRESTARTED).
PRESTARTING Prestarting state - in the process of prestarting.
RESETTING Resetting emu - got RESET command.

Method Summary

Modifier and Type	Method and Description
java.util.EnumSet<CODATransition>	allowed() Get the set of allowed transitions from this state.
static CODAState	get(java.lang.String s) Map from CODAState name to a particular enum.
java.lang.String	getDescription() Get the description of this state.
static CODAState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CODAState[]	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

Methods inherited from interface org.jlab.coda.emu.support.codaComponent.CODAStateIF

name

Enum Constant Detail

BOOTED

public static final CODAState BOOTED

BOOTED state.

CONFIGURED

public static final CODAState CONFIGURED

CONFIGURED state.

DOWNLOADED

public static final CODAState DOWNLOADED

DOWNLOADED state (same as ENDED).

PAUSED

public static final CODAState PAUSED

PAUSED state (same as PRESTARTED).

ACTIVE

public static final CODAState ACTIVE

ACTIVE state.

CONFIGURING

public static final CODAState CONFIGURING

Configuring state - in the process of configuring.

DOWNLOADING

public static final CODAState DOWNLOADING

Downloading state - in the process of downloading.

PRESTARTING

public static final CODAState PRESTARTING

Prestarting state - in the process of prestarting.

ACTIVATING

public static final CODAState ACTIVATING

Activating state - in the process of becoming active.

ENDING

public static final CODAState ENDING

Ending state - got END command but no END event yet.

RESETTING

public static final CODAState RESETTING

Resetting emu - got RESET command.

ERROR

public static final CODAState ERROR

ERROR state.

Method Detail

values

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

Returns:

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

valueOf

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

get

public static CODAState get(java.lang.String s)

Map from CODAState name to a particular enum.

Parameters:

s - name of CODAState.

Returns:

associated enum, else null.

getDescription

public java.lang.String getDescription()

Get the description of this state.

Specified by:

getDescription in interface CODAStateIF

Returns:

description of this state

allowed

public java.util.EnumSet<CODATransition> allowed()

Get the set of allowed transitions from this state.

Specified by:

allowed in interface CODAStateIF

Returns:

set of allowed transitions from this state.