Package org.eso.ias.types

Enum Class AlarmState

java.lang.Object

java.lang.Enum<AlarmState>

org.eso.ias.types.AlarmState

All Implemented Interfaces:

Serializable, Comparable<AlarmState>, Constable

public enum AlarmState
extends Enum<AlarmState>

The state and state machine of an Alarm

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
CLEAR_ACK	Alarm clear and acknowledged
CLEAR_UNACK	Alarm clear and unacknowledged
SET_ACK	Alarm set and acknowledged
SET_UNACK	Alarm set and unacknowledged

Method Summary

Modifier and Type	Method	Description
AlarmState	ack()	The alarm has been Acked (by operator)
AlarmState	clear()	The alarm is clear (by the TF)
final boolean	isAcked()
final boolean	isCleared()
final boolean	isSet()
AlarmState	set()	The alarm is set (by the TF)
static AlarmState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AlarmState[]	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

CLEAR_ACK

public static final AlarmState CLEAR_ACK

Alarm clear and acknowledged

CLEAR_UNACK

public static final AlarmState CLEAR_UNACK

Alarm clear and unacknowledged

SET_UNACK

public static final AlarmState SET_UNACK

Alarm set and unacknowledged

SET_ACK

public static final AlarmState SET_ACK

Alarm set and acknowledged

Method Details

values

public static AlarmState[] 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 AlarmState 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

isSet

public final boolean isSet()

Returns:

true if the alarm is set; false otherwise

isCleared

public final boolean isCleared()

Returns:

true if the alarm is cleared; false otherwise

isAcked

public final boolean isAcked()

Returns:

true if the alarm has been acknowledged false otherwise

ack

public AlarmState ack()

The alarm has been Acked (by operator)

set

public AlarmState set()

The alarm is set (by the TF)

clear

public AlarmState clear()

The alarm is clear (by the TF)