Package org.see.skf.util.models

Enum ModeTransitionRequest.MTRMode

java.lang.Object

java.lang.Enum<ModeTransitionRequest.MTRMode>

org.see.skf.util.models.ModeTransitionRequest.MTRMode

All Implemented Interfaces:

Serializable, Comparable<ModeTransitionRequest.MTRMode>

Enclosing class:

ModeTransitionRequest

public static enum ModeTransitionRequest.MTRMode
extends Enum<ModeTransitionRequest.MTRMode>

The run mode that can be requested by a federate other than the Master federate. There are only 3 valid Mode Transition Request (MTR) mode values: MTR_GOTO_RUN, MTR_GOTO_FREEZE, MTR_GOTO_SHUTDOWN. Of these three valid mode requests, only 7 combinations of current execution mode and requested mode are valid:

1. EXEC_MODE_UNINITIALIZED -> EXEC_MODE_SHUTDOWN
2. EXEC_MODE_INITIALIZED -> EXEC_MODE_FREEZE
3. EXEC_MODE_INITIALIZED -> EXEC_MODE_SHUTDOWN
4. EXEC_MODE_RUNNING -> EXEC_MODE_FREEZE
5. EXEC_MODE_RUNNING -> EXEC_MODE_SHUTDOWN
6. EXEC_MODE_FREEZE -> EXEC_MODE_RUNNING
7. EXEC_MODE_FREEZE -> EXEC_MODE_SHUTDOWN

Since:

1.5

Enum Constant Summary

Enum Constants

Enum Constant	Description
MTR_GOTO_FREEZE
MTR_GOTO_RUN
MTR_GOTO_SHUTDOWN
MTR_UNDESIGNATED

Method Summary

Modifier and Type	Method	Description
short	getValue()
static ModeTransitionRequest.MTRMode	query(short value)
static ModeTransitionRequest.MTRMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ModeTransitionRequest.MTRMode[]	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 Details

MTR_UNDESIGNATED

public static final ModeTransitionRequest.MTRMode MTR_UNDESIGNATED

MTR_GOTO_RUN

public static final ModeTransitionRequest.MTRMode MTR_GOTO_RUN

MTR_GOTO_FREEZE

public static final ModeTransitionRequest.MTRMode MTR_GOTO_FREEZE

MTR_GOTO_SHUTDOWN

public static final ModeTransitionRequest.MTRMode MTR_GOTO_SHUTDOWN

Method Details

values

public static ModeTransitionRequest.MTRMode[] values()

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

Returns:

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

valueOf

public static ModeTransitionRequest.MTRMode valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

query

public static ModeTransitionRequest.MTRMode query(short value)

getValue

public short getValue()