Package org.yamcs.studio.data.vtype

Enum Class AlarmSeverity

java.lang.Object
java.lang.Enum<AlarmSeverity>
org.yamcs.studio.data.vtype.AlarmSeverity
All Implemented Interfaces:
Serializable, Comparable<AlarmSeverity>, Constable
public enum AlarmSeverity extends Enum<AlarmSeverity>
Severity of an alarm.

Values are provided in order of increasing severity, so you can rely on Enum.ordinal() and Enum.compareTo(java.lang.Enum) for comparison and ordering. In case additional AlarmSeverity values are added in the future, which is very unlikely, they will be added in order as well.

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

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    INVALID
    There is a major problem with the value itself: the exact meaning is defined by the channel, 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 channel, 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 channel, but typically this means that the value is valid and is outside some working range.
    NONE
    The current value is valid, and there is no alarm.
    UNDEFINED
    The channel cannot be read and its state is undefined: the exact meaning is defined by the channel, but typically this means that the client is either disconnected or connected with no read access.

  • Method Summary

    Modifier and Type
    Method
    Description
    static List<String>
    labels()
    Returns the list of labels for the severity.
    static AlarmSeverity
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static AlarmSeverity[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

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

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NONE

      public static final AlarmSeverity NONE
      The current value is valid, and there is no alarm.

    • MINOR

      public static final AlarmSeverity MINOR
      There is a minor problem with the value: the exact meaning is defined by the channel, 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 channel, 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 channel, but typically this means that the returned value is not a real representation of the actual value.

    • UNDEFINED

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

  • Method Details

    • values

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

    • labels

      public static List<String> labels()
      Returns the list of labels for the severity.

      This is useful to create VEnums containing severities.

      Returns:
      an immutable list with the labels