Package xal.smf.impl.profile

Annotation Interface ASignal

@Documented @Inherited @Retention(RUNTIME) @Target(FIELD) public @interface ASignal

Annotation for describing the data acquisition channels for a single plane of a wire profile measurement device. The names of the read back channels for both the position array and the value array are included here. Also, the types of these arrays can be specified.

Ported from XAL on Jul 15, 2014.
· Jonathan M. Freed

Since:
Jan 20, 2013
Author:
Christopher K. Allen

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    ASignal.ASet
    Annotation for describing all the data acquisition channels of a wire profile measurement device.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    hndPosRb
    The name of the profile position array read back channel.
    String
    hndValRb
    The name of the profile value array acquisition channel.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    hndCntRb
    The XAL channel handle for the number of active signal samples.
    String
    hndNseAvgRb
    The name of the channel containing the signal noise mean.
    String
    hndNseVarRb
    The name of the channel containing the signal noise variance.
    Class<?>
    typeCnt
    The type of the sample count channel.
    Class<?>
    typeNseAvg
    The data type of the noise mean value.
    Class<?>
    typeNseVar
    The data type of the noise variance value.
    Class<?>
    typePos
    The type of the profile position array.
    Class<?>
    typeVal
    The class type of profile value array.

  • Element Details

    • hndPosRb

      String hndPosRb
      The name of the profile position array read back channel.
      Returns:
      the name of the channel serving up the position array, no default value
      Since:
      Jan 31, 2013

    • hndValRb

      String hndValRb
      The name of the profile value array acquisition channel.
      Returns:
      value array channel name, no default value
      Since:
      Jan 31, 2013

    • typeCnt

      Class<?> typeCnt
      The type of the sample count channel.
      Returns:
      class type of the sample count, default value is int.class
      Since:
      Jan 31, 2013
      Default:
      int.class

    • hndCntRb

      String hndCntRb
      The XAL channel handle for the number of active signal samples. This differs from the size of the signal array returned by the channel in ADaqWire.Signal.Hor#hndPosRb which is the buffer size of the DAQ controller.
      Returns:
      channel handle for the number of signal samples, default ""
      Since:
      Jan 31, 2013
      Default:
      ""

    • typePos

      Class<?> typePos
      The type of the profile position array.
      Returns:
      the class type of the position array, default value is double[].class
      Since:
      Jan 31, 2013
      Default:
      double[].class

    • typeVal

      Class<?> typeVal
      The class type of profile value array.
      Returns:
      the type of the value array, default value is double[].class
      Since:
      Jan 31, 2013
      Default:
      double[].class

    • typeNseAvg

      Class<?> typeNseAvg
      The data type of the noise mean value. The default value is double.class.
      Returns:
      class type of the noise mean parameter, default value is double.class
      Since:
      Dec 7, 2011
      Default:
      double.class

    • hndNseAvgRb

      String hndNseAvgRb
      The name of the channel containing the signal noise mean.
      Returns:
      noise variance channel name, default value is "" (empty string)
      Since:
      Dec 7, 2011
      Default:
      ""

    • typeNseVar

      Class<?> typeNseVar
      The data type of the noise variance value.
      Returns:
      class type of the noise variance parameter, the default value is double.class.
      Since:
      Dec 7, 2011
      Default:
      double.class

    • hndNseVarRb

      String hndNseVarRb
      The name of the channel containing the signal noise variance.
      Returns:
      noise variance channel name, no default value
      Since:
      Dec 7, 2011
      Default:
      ""