AlarmSeverity (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 AlarmSeverity

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

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

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

Severity of an alarm.

One should always bear in mind that the alarm severity of the IOC is set on the record, and not on the individual channel. If you one is not connecting to the value field of the record, the severity does not reflect the state of that field.

For example: a record may be INVALID meaning that the value of the field was not correctly read by the hardware; if one connects to the display limit field, the value of that field will still be ok, but the alarm severity (if requested) would say INVALID.

Author:: carcassi

Enum Constant Summary
`INVALID` There is a major problem with the value itself: the exact meaning is defined by the PV, but typically this means that the returned value is not a real representation of the actual value.
`MAJOR` There is a major problem with the value: the exact meaning is defined by the PV, but typically this means that the value is valid and is outside some working range.
`MINOR` There is a minor problem with the value: the exact meaning is defined by the PV, but typically this means that the value is valid and is outside some working range.
`NONE` The current value is valid, and there are no alarm.
`UNDEFINED` The record cannot be read and its state is undefined: the exact meaning is defined by the PV, but typically this means that the client is either disconnected or connected with no read access.

Method Summary
`static AlarmSeverity`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static AlarmSeverity[]`	`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 AlarmSeverity NONE

The current value is valid, and there are no alarm.

MINOR

public static final AlarmSeverity MINOR

There is a minor problem with the value: the exact meaning is defined by the PV, but typically this means that the value is valid and is outside some working range.

MAJOR

public static final AlarmSeverity MAJOR

There is a major problem with the value: the exact meaning is defined by the PV, but typically this means that the value is valid and is outside some working range.

INVALID

public static final AlarmSeverity INVALID

There is a major problem with the value itself: the exact meaning is defined by the PV, but typically this means that the returned value is not a real representation of the actual value.

UNDEFINED

public static final AlarmSeverity UNDEFINED

The record cannot be read and its state is undefined: the exact meaning is defined by the PV, but typically this means that the client is either disconnected or connected with no read access. The value is either stale or invalid.

Method Detail

values

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

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

valueOf

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