Package org.eso.ias.types

Enum Class OperationalMode

java.lang.Object

java.lang.Enum<OperationalMode>

org.eso.ias.types.OperationalMode

All Implemented Interfaces:

Serializable, Comparable<OperationalMode>, Constable

public enum OperationalMode
extends Enum<OperationalMode>

The operational mode of a monitor point value

Author:

acaproni

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSING	Shutting down
DEGRADED	Only partially operational
INITIALIZATION	Initialization on going
MAINTENANCE	Maintenance
MALFUNCTIONING	Device malfunctioning
OPERATIONAL	Fully operational
SHUTTEDDOWN	Shut down
STARTUP	Starting up
UNKNOWN	Unknown state

Method Summary

Modifier and Type	Method	Description
static OperationalMode	getModeFromInputs(Iterable<OperationalMode> modesOfInputs)	Get a OperationalMode from the modes if they agree or UNKNOWN This method is an helper to provide the mode of the output depending of the many inputs of the TF.
static OperationalMode	getModeFromInputs(Iterable<OperationalMode> modesOfInputs, OperationalMode fallbackMode)	Get the OperationalMode from the modes if they agree or returns the passed fallbackMode.
static OperationalMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OperationalMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLOSING

public static final OperationalMode CLOSING

Shutting down

DEGRADED

public static final OperationalMode DEGRADED

Only partially operational

INITIALIZATION

public static final OperationalMode INITIALIZATION

Initialization on going

MAINTENANCE

public static final OperationalMode MAINTENANCE

Maintenance

OPERATIONAL

public static final OperationalMode OPERATIONAL

Fully operational

SHUTTEDDOWN

public static final OperationalMode SHUTTEDDOWN

Shut down

STARTUP

public static final OperationalMode STARTUP

Starting up

UNKNOWN

public static final OperationalMode UNKNOWN

Unknown state

MALFUNCTIONING

public static final OperationalMode MALFUNCTIONING

Device malfunctioning

Method Details

values

public static OperationalMode[] values()

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

Returns:

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

valueOf

public static OperationalMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getModeFromInputs

public static OperationalMode getModeFromInputs(Iterable<OperationalMode> modesOfInputs,
 OperationalMode fallbackMode)

Get the OperationalMode from the modes if they agree or returns the passed fallbackMode. This method is an helper to provide the mode of the output depending of the many inputs of the TF. If there is only one input or the modes of the inputs are all the same than that mode is returned. Otherwise the default is returned.

Parameters:

modesOfInputs - the modes of the inputs of the TF

fallbackMode - the mode to return if the modes of the inputs disagree

Returns:

the OperationalMode from the modes if they agree; returns the passed fallbackMode otherwise

See Also:

• Issue #119

getModeFromInputs

public static OperationalMode getModeFromInputs(Iterable<OperationalMode> modesOfInputs)

Get a OperationalMode from the modes if they agree or UNKNOWN This method is an helper to provide the mode of the output depending of the many inputs of the TF. If there is only one input or the modes of the inputs are all the same than that mode is returned. Otherwise the default is returned.

Parameters:

modesOfInputs - the modes of the inputs of the TF

Returns:

the OperationalMode from the modes if they agree; otherwise UNKNOWN

See Also:

• Issue #119