Package org.eso.ias.types

Enum Class IdentifierType

java.lang.Object
java.lang.Enum<IdentifierType>
org.eso.ias.types.IdentifierType
All Implemented Interfaces:
Serializable, Comparable<IdentifierType>, Constable
public enum IdentifierType extends Enum<IdentifierType>
The types of an identifier of an IASIO.

There is a relationship between types, meaning that a type can have zero, one or more types of parents of a specified type. Note: IAS tools sends an Heartbeat with their identifier that is another type of identifier defined in the Heartbeat module. The reason of the separation of the 2 types of identifiers is documented in [[https://github.com/IntegratedAlarmSystem-Group/ias/issues/145 #145]] and [[https://github.com/IntegratedAlarmSystem-Group/ias/issues/149 #149]]

Author:
acaproni
See Also:
  • Identifier

  • 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
    ASCE
    The type of a computing element identifier that runs in a DASU
    CLIENT
    A IAS client that does not generate alarms GUIs are an example of CLIENT; a tool to send commands is another example.
    CONVERTER
    The type of the identifier for the converter that translates a value or alarm produced by a remote monitored system into a valid IAS data structure.
    CORETOOL
    A CORE tool that can generate alarms.
    DASU
    The type of a distributed unit identifier that runs in a superivisor
    IASIO
    The type of IASIO identifier.
    MONITORED_SOFTWARE_SYSTEM
    The type for the monitored software system that produced a monitor point value or alarm
    PLUGIN
    The type of a plugin that retrieved a monitor point value or alarm from a monitored system
    SUPERVISOR
    The type of a supervisor identifier

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final IdentifierType[]
    parents
    Possible parents of a identifier

  • Method Summary

    Modifier and Type
    Method
    Description
    static IdentifierType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static IdentifierType[]
    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

    • MONITORED_SOFTWARE_SYSTEM

      public static final IdentifierType MONITORED_SOFTWARE_SYSTEM
      The type for the monitored software system that produced a monitor point value or alarm

      For example: [ID=ACS, type=MONITORED_SOFTWARE_SYSTEM]

    • PLUGIN

      public static final IdentifierType PLUGIN
      The type of a plugin that retrieved a monitor point value or alarm from a monitored system

      For example: [ID=ACS_Plugin, type=PLUGIN

    • CONVERTER

      public static final IdentifierType CONVERTER
      The type of the identifier for the converter that translates a value or alarm produced by a remote monitored system into a valid IAS data structure.

    • SUPERVISOR

      public static final IdentifierType SUPERVISOR
      The type of a supervisor identifier

    • DASU

      public static final IdentifierType DASU
      The type of a distributed unit identifier that runs in a superivisor

    • ASCE

      public static final IdentifierType ASCE
      The type of a computing element identifier that runs in a DASU

    • CORETOOL

      public static final IdentifierType CORETOOL
      A CORE tool that can generate alarms.

    • CLIENT

      public static final IdentifierType CLIENT
      A IAS client that does not generate alarms GUIs are an example of CLIENT; a tool to send commands is another example.

    • IASIO

      public static final IdentifierType IASIO
      The type of IASIO identifier. The IASIO can be generated by - a converter (ultimately by a plugin) - an ASCE - a CORE tool

  • Field Details

    • parents

      public final IdentifierType[] parents
      Possible parents of a identifier

  • Method Details

    • values

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