Package xal.smf.scada

Annotation Interface AScada.Record

Enclosing class:
AScada
@Documented @Retention(RUNTIME) @Target(TYPE) public static @interface AScada.Record
Alternate method of annotating the fields of a SCADA structure. The data structure itself is annotated, rather than each individual field. The annotations are thus arrays of field properties, each array containing an entry for each field of the structure.
Since:
Sep 30, 2011
Author:
Christopher K. Allen

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    boolean[]
    arrCtl
    Array of controllable flags for each SCADA field in the data structure.
    String[]
    arrHndCtl
    Array of all the XAL Channel handles for the SCADA fields in this data structure.
    String[]
    arrHndRb
    Array of all the XAL Channel handles for the SCADA fields in this data structure.
    String[]
    arrNames
    Array of all the SCADA field names within the data structure.
    Class<?>[]
    arrTypes
    Array of the class types of all the SCADA fields within this data structure.
    int
    cntFlds
    The number of SCADA fields within the data structure.

  • Element Details

    • cntFlds

      int cntFlds
      The number of SCADA fields within the data structure. Thus, also the size of each property array.
      Returns:
      number of SCADA fields
      Since:
      Sep 30, 2011

    • arrNames

      String[] arrNames
      Array of all the SCADA field names within the data structure. These are Java class attributes which are to be specified as SCADA fields.
      Returns:
      array containing the names of the SCADA fields
      Since:
      Sep 30, 2011

    • arrTypes

      Class<?>[] arrTypes
      Array of the class types of all the SCADA fields within this data structure.
      Returns:
      array of class types for the SCADA fields
      Since:
      Sep 30, 2011

    • arrHndRb

      String[] arrHndRb
      Array of all the XAL Channel handles for the SCADA fields in this data structure. These are the read back channels.
      Returns:
      array of read back channel handles
      Since:
      Sep 30, 2011

    • arrHndCtl

      String[] arrHndCtl
      Array of all the XAL Channel handles for the SCADA fields in this data structure. These are the set value channels.
      Returns:
      array of set value channel handles
      Since:
      Sep 30, 2011

    • arrCtl

      boolean[] arrCtl
      Array of controllable flags for each SCADA field in the data structure. If the field is flagged as true then a non-null set-value channel handle must be present.
      Returns:
      array of controllable PV flags for each SCADA field
      Since:
      Sep 30, 2011