Package xal.smf.scada

Annotation Interface AScada.Field

Enclosing class:
AScada
@Documented @Retention(RUNTIME) @Target(FIELD) public static @interface AScada.Field
Annotation specifying a class field is part of a SCADA data structure. The annotation provides the XAL channel handles for setting and read back of the field value, as well as type information and whether or not the field value is controllable.
Since:
Feb 8, 2011
Author:
Christopher K. Allen

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    boolean
    ctrl
    Specifies whether or not the field is controllable as an EPICS PV.
    String
    hndRb
    The XAL channel handle of the read back channel for the field.
    Class<?>
    type
    The primitive data type of the field

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    hndSet
    Channel handle of the field's set-value channel, if it exists.

  • Element Details

    • type

      Class<?> type
      The primitive data type of the field
      Returns:
      type as a Java class
      Since:
      Feb 8, 2011

    • ctrl

      boolean ctrl
      Specifies whether or not the field is controllable as an EPICS PV. That is, is it a "read/write" channel.
      Returns:
      true if the corresponding PV can be set false if the PV is read only
      Since:
      Feb 8, 2011

    • hndRb

      String hndRb
      The XAL channel handle of the read back channel for the field.
      Returns:
      name of the read back channel
      Since:
      Feb 8, 2011

    • hndSet

      String hndSet
      Channel handle of the field's set-value channel, if it exists.
      Returns:
      name of set channel handle.
      Since:
      Feb 8, 2011
      Default:
      ""