Package org.epics.pvdata.property

Enum AlarmStatus

java.lang.Object

java.lang.Enum<AlarmStatus>

org.epics.pvdata.property.AlarmStatus

All Implemented Interfaces:

Serializable, Comparable<AlarmStatus>

public enum AlarmStatus
extends Enum<AlarmStatus>

AlarmStatus definitions.

Author:

mrk

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLIENT	An error generated by the client (e.g channel not found, disconnected, ...)
CONF	An error generated by an error in configuration of one or multiple records.
DB	An error generated by the interaction of multiple records.
DEVICE	An error conditioned generated by the hardware.
DRIVER	An error conditioned raised by the driver (e.g.
NONE	No alarm.
RECORD	An error generated as part of the record calculation (e.g.
UNDEFINED	The status for a record that was never processed.

Method Summary

Modifier and Type	Method	Description
static AlarmStatus	getStatus(int value)	Get the alarm status.
static String[]	getStatusNames()	Get the names associated with each status.
static AlarmStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AlarmStatus[]	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

NONE

public static final AlarmStatus NONE

No alarm.

DEVICE

public static final AlarmStatus DEVICE

An error conditioned generated by the hardware.

DRIVER

public static final AlarmStatus DRIVER

An error conditioned raised by the driver (e.g. the device is not responding, cannot write to it, ...)

RECORD

public static final AlarmStatus RECORD

An error generated as part of the record calculation (e.g. alarm limits, state alarm, error in the calculation)

DB

public static final AlarmStatus DB

An error generated by the interaction of multiple records.

CONF

public static final AlarmStatus CONF

An error generated by an error in configuration of one or multiple records.

UNDEFINED

public static final AlarmStatus UNDEFINED

The status for a record that was never processed.

CLIENT

public static final AlarmStatus CLIENT

An error generated by the client (e.g channel not found, disconnected, ...)

Method Detail

values

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

Returns:

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

valueOf

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

getStatus

public static AlarmStatus getStatus(int value)

Get the alarm status.

Parameters:

value - the integer value

Returns:

The alarm status

getStatusNames

public static String[] getStatusNames()

Get the names associated with each status.

Returns:

the array of names