AlarmStatus (CSS Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.epics.pvmanager.data
Enum AlarmStatus

java.lang.Object
  java.lang.Enum<AlarmStatus>
      org.epics.pvmanager.data.AlarmStatus

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<AlarmStatus>

public enum AlarmStatus
extends java.lang.Enum<AlarmStatus>
extends java.lang.Enum<AlarmStatus>

Source of the alarm.

The alarm status reflect where the error has been generated. The same category is used by both EPICS 3 and EPICS 4.

EPICS 3 status is converted according to the following table:

DEVICE	HW_LIMIT_ALARM
DRIVER	READ_ALARM, WRITE_ALARM, COMM_ALARM, TIMEOUT_ALARM, READ_ACCESS_ALARM, WRITE_ACCESS_ALARM
RECORD	HIHI_ALARM, HIGH_ALARM, LOLO_ALARM, LOW_ALARM, STATE_ALARM, CALC_ALARM, DISABLE_ALARM, SIMM_ALARM
DB	SCAN_ALARM, LINK_ALARM
CONF	SOFT_ALARM, BAD_SUB_ALARM
UNDEFINED	UDF_ALARM

Author:: carcassi

Enum Constant Summary
`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 associated.
`RECORD` An error generated as part of the record calculation (e.g.
`UNDEFINED` The status for a record that was never processed.

Method Summary
`static AlarmStatus`	`valueOf(java.lang.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

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, ...)

NONE

public static final AlarmStatus NONE

No alarm associated.

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(java.lang.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:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name; java.lang.NullPointerException - if the argument is null