Enum Class AlarmLevel

java.lang.Object

java.lang.Enum<AlarmLevel>

neqsim.process.alarm.AlarmLevel

All Implemented Interfaces:

Serializable, Comparable<AlarmLevel>, Constable

public enum AlarmLevel
extends Enum<AlarmLevel>
implements Serializable

Enumerates the discrete alarm levels used when evaluating measurement values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AlarmLevel.Direction	Direction of the alarm (high or low).

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HI	High alarm limit exceeded.
HIHI	High-high alarm limit exceeded.
LO	Low alarm limit exceeded.
LOLO	Low-low alarm limit exceeded.

Field Summary

Fields

Modifier and Type	Field	Description
private final AlarmLevel.Direction	direction
private final int	priority

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AlarmLevel(int priority, AlarmLevel.Direction direction)

Method Summary

Modifier and Type	Method	Description
AlarmLevel.Direction	getDirection()	Returns the direction of the alarm.
int	getPriority()	Returns a relative priority used when comparing alarm severities.
static AlarmLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AlarmLevel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

LOLO

public static final AlarmLevel LOLO

Low-low alarm limit exceeded.

LO

public static final AlarmLevel LO

Low alarm limit exceeded.

HI

public static final AlarmLevel HI

High alarm limit exceeded.

HIHI

public static final AlarmLevel HIHI

High-high alarm limit exceeded.

Field Details

priority

private final int priority

direction

private final AlarmLevel.Direction direction

Constructor Details

AlarmLevel

private AlarmLevel(int priority,
 AlarmLevel.Direction direction)

Method Details

values

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

getPriority

public int getPriority()

Returns a relative priority used when comparing alarm severities.

Returns:

priority where higher magnitude indicates a more severe alarm

getDirection

public AlarmLevel.Direction getDirection()

Returns the direction of the alarm.

Returns:

HIGH if the alarm is triggered by high values, otherwise LOW