org.jlab.coda.emu.support.codaComponent

Enum CODATransition

java.lang.Object

java.lang.Enum<CODATransition>

org.jlab.coda.emu.support.codaComponent.CODATransition

All Implemented Interfaces:

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

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

An enum which contains a list of possible transitions in CODA Emu state machine. Each of these transitions can be enabled or disabled.

                 *****************
                 * State Machine *
                 *****************
 _________________________________________________________________
                 |                 |
    transition   |      STATE      |  transition
 ________________|_________________|______________________________

                               (if reset from ERROR or BOOTED)
                  <- BOOTED <-----------------------------,
                 |                                        |
     configure   |                                        |
                 |               <------------------------|
                 '-> CONFIGURED ->----------------------->|
                  <-                                      ^
                 |                                        |
     download    |                                        |
                 |                                        |
                 '-> DOWNLOADED ->----------------------->|
                  <-            <-,<----------,           ^
                 |                ^           ^           |
                 |                |           |           |
     prestart    |                | end       | end       | reset
                 |                |           |           |
                 '-> PAUSED -----> -----------|---------->|
                  <-                          |           ^
                 |                            |           |
        go       |                            |           |
                 |                            |           |
                 '->  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
CONFIGURE Configure transition.
DOWNLOAD Download transition.
END End transition.
GO Go transition.
PAUSE Pause transition.
PRESTART Prestart transition.
RESET Reset transition.

Method Summary

Modifier and Type	Method and Description
java.lang.String	description() Get the description of this transition.
CODAStateIF	success() Returns the CODA run control State (CODAState enum object) upon success of this transition.
static CODATransition	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CODATransition[]	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

CONFIGURE

public static final CODATransition CONFIGURE

Configure transition.

DOWNLOAD

public static final CODATransition DOWNLOAD

Download transition.

PRESTART

public static final CODATransition PRESTART

Prestart transition.

GO

public static final CODATransition GO

Go transition.

END

public static final CODATransition END

End transition.

PAUSE

public static final CODATransition PAUSE

Pause transition.

RESET

public static final CODATransition RESET

Reset transition.

Method Detail

values

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

Returns:

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

valueOf

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

description

public java.lang.String description()

Get the description of this transition.

Returns:

description string.

success

public CODAStateIF success()

Returns the CODA run control State (CODAState enum object) upon success of this transition.

Returns:

State (CODAState enum object) upon success of this transition