com.aquenos.epics.jackie.common.value

Enum ChannelAccessAlarmSeverity

java.lang.Object

java.lang.Enum<ChannelAccessAlarmSeverity>

com.aquenos.epics.jackie.common.value.ChannelAccessAlarmSeverity

All Implemented Interfaces:

Serializable, Comparable<ChannelAccessAlarmSeverity>

public enum ChannelAccessAlarmSeverity
extends Enum<ChannelAccessAlarmSeverity>

Alarm severity associated with a Channel Access channel.

Author:

Sebastian Marsching

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVALID_ALARM Unknown alarm severity.
MAJOR_ALARM Major Alarm.
MINOR_ALARM Minor alarm.
NO_ALARM No alarm.

Method Summary

Methods

Modifier and Type	Method and Description
static ChannelAccessAlarmSeverity	forSeverityCode(short severityCode) Returns the severity for the given severityCode.
short	toSeverityCode() Returns the severity code associated with this severity.
static ChannelAccessAlarmSeverity	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChannelAccessAlarmSeverity[]	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

NO_ALARM

public static final ChannelAccessAlarmSeverity NO_ALARM

No alarm. Indicates that everything is OK.

MINOR_ALARM

public static final ChannelAccessAlarmSeverity MINOR_ALARM

Minor alarm. Typically, this means that a value is not within the expected range, but no immediate action is required.

MAJOR_ALARM

public static final ChannelAccessAlarmSeverity MAJOR_ALARM

Major Alarm. This severity typically indicates that a parameter is in a range that indicates a malfunction and actions are needed.

INVALID_ALARM

public static final ChannelAccessAlarmSeverity INVALID_ALARM

Unknown alarm severity. Typically, this is caused by a parameter being out of date (e.g. because it could not be read from the hardware). This is the highest severity, because the actual severity cannot be determined and thus the worst has to be expected.

Method Detail

values

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

Returns:

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

valueOf

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

toSeverityCode

public short toSeverityCode()

Returns the severity code associated with this severity. This is an integer that uniquely identifies this severity. This number is suitable to be sent over the network.

Returns:

integer number between 0 and 3, identifying this severity.

See Also:

forSeverityCode(short)

forSeverityCode

public static ChannelAccessAlarmSeverity forSeverityCode(short severityCode)

Returns the severity for the given severityCode. This can be used to translate a severity code received from the network into a severity.

Parameters:

severityCode - integer number identifying the severity. Must be between 0 and 3.

Returns:

the severity identified by the severityCode, never null.

Throws:

IllegalArgumentException - if the severityCode does not represent a valid severity (is not 0, 1, 2, or 3).