Package xal.smf.impl.profile

Enum Class ProfileDevice.ANGLE

java.lang.Object
java.lang.Enum<ProfileDevice.ANGLE>
xal.smf.impl.profile.ProfileDevice.ANGLE
All Implemented Interfaces:
Serializable, Comparable<ProfileDevice.ANGLE>, Constable
Enclosing class:
ProfileDevice
public static enum ProfileDevice.ANGLE extends Enum<ProfileDevice.ANGLE>
Enumeration of the projection angles used to produce the profile data.
Since:
Jul 16, 2009
Author:
Christopher K. Allen

  • Enum Constant Details

  • Method Details

    • values

      public static ProfileDevice.ANGLE[] 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 ProfileDevice.ANGLE 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

    • getIndex

      public int getIndex()
      The the array index for this plot enumeration constant.
      Returns:
      plot array index
      Since:
      Jul 16, 2009

    • getLabel

      public String getLabel()
      Returns the plot label for this enumeration constant.
      Returns:
      plot label
      Since:
      Jul 16, 2009

    • getSignalAttrs

      public SignalAttrs getSignalAttrs(SignalAttrSet setAttrs)
      Extracts the proper signal attributes w.r.t. to this plane from the given set of signal attributes.
      Parameters:
      setAttrs - set of signal attributes, one for each phase plane
      Returns:
      signal attributes corresponding to this phase plane
      Since:
      Mar 26, 2014

    • getSignalPosFd

      public ScadaFieldDescriptor getSignalPosFd(Class<? extends SignalSet> clsData) throws ScadaAnnotationException
      Extracts the field descriptor for the position channel from the annotations of the given SignalSet-derived class type.
      Parameters:
      clsData - the Data-derived child class with DAQ annotations
      Returns:
      position channel field descriptor for this plane
      Throws:
      ScadaAnnotationException - a required field of the ASet annotation was empty or annotation not found
      Since:
      Sep 27, 2011

    • getSignalValFd

      public ScadaFieldDescriptor getSignalValFd(Class<? extends SignalSet> clsData) throws ScadaAnnotationException
      Extracts the field descriptor for the signal value channel from the set of acquisition descriptors.
      Parameters:
      clsData - the SignalSet-derived child class with DAQ annotations
      Returns:
      signal value channel field descriptor for this plane
      Throws:
      ScadaAnnotationException - a required field of the ASet annotation was empty or annotation not found
      Since:
      Feb 22, 2011