Package xal.smf.impl.profile

Enum Class SignalAttrs.ATTRS

java.lang.Object
java.lang.Enum<SignalAttrs.ATTRS>
xal.smf.impl.profile.SignalAttrs.ATTRS
All Implemented Interfaces:
Serializable, Comparable<SignalAttrs.ATTRS>, Constable
Enclosing class:
SignalAttrs
public static enum SignalAttrs.ATTRS extends Enum<SignalAttrs.ATTRS>
Enumeration of the signal properties data fields.
Since:
Feb 23, 2010
Author:
Christopher K. Allen

  • Enum Constant Details

    • AMP

      public static final SignalAttrs.ATTRS AMP
      Signal amplitude

    • OFFSET

      public static final SignalAttrs.ATTRS OFFSET
      Additive offset of the signal from zero baseline

    • AREA

      public static final SignalAttrs.ATTRS AREA
      Area under the signal curve; the integral; the total mass

    • MEAN

      public static final SignalAttrs.ATTRS MEAN
      The statistical average; the center of mass

    • STDEV

      public static final SignalAttrs.ATTRS STDEV
      The standard deviation

  • Method Details

    • values

      public static SignalAttrs.ATTRS[] 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 SignalAttrs.ATTRS 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

    • createDescriptor

      public ScadaFieldDescriptor createDescriptor(ASignalAttrs annSig)

      Creates a new SCADA (PV) field descriptor for the signal attribute represented by this enumeration constant. The data to create the field descriptor is taken from the provided annotation.

      NOTE:

      · If the annotation field corresponding to this enumeration is left blank or set to the empty string "", the method will throw a NoSuchFieldException. Since it is not necessary for all handles to be specified this is not necessarily a failure condition.

      Parameters:
      annSig - the annotation from which we are extracting the parameters
      Returns:
      A new SCADA field descriptor for the given signal attribute, or null if field is missing
      Since:
      Feb 6, 2013

    • getFieldName

      public String getFieldName()
      Returns the name of the field in the data structure which corresponds to this enumeration constant.
      Returns:
      data structure field name
      Since:
      Nov 13, 2009

    • getFieldValue

      public double getFieldValue(SignalAttrs data)
      Using reflection, we return the value of the field that this enumeration constant represents, within the given data structure.
      Parameters:
      data - data structure having field corresponding to this constant
      Returns:
      value of the given data structure's field
      Since:
      Apr 22, 2010

    • setFieldValue

      public double setFieldValue(SignalAttrs attrs, double dblVal)
      Using reflection, we set the field value of the given SignalAttrs object that this enumeration constant represents. The value of that field is the double valued field provided in the arguments.
      Parameters:
      attrs - data structure to receive new field value
      dblVal - new value of that field
      Since:
      Apr 22, 2010