Package xal.smf

Enum Class TimingCenter.BEAM_MODE

java.lang.Object
java.lang.Enum<TimingCenter.BEAM_MODE>
xal.smf.TimingCenter.BEAM_MODE
All Implemented Interfaces:
Serializable, Comparable<TimingCenter.BEAM_MODE>, Constable
Enclosing class:
TimingCenter
public static enum TimingCenter.BEAM_MODE extends Enum<TimingCenter.BEAM_MODE>
Enumeration of the possible values of the Beam Model process variable. These are string values, or indexed integers, so providing an enumeration set helps avoid the brittleness of hard-coding the values.
Since:
Nov 4, 2011
Author:
Christopher K. Allen

  • Enum Constant Details

    • UNKNOWN

      public static final TimingCenter.BEAM_MODE UNKNOWN
      Error! The beam mode is in a condition of unknown state.

    • OFF

      public static final TimingCenter.BEAM_MODE OFF
      The beam is off (no beam mode)

    • MPSTEST

      public static final TimingCenter.BEAM_MODE MPSTEST
      We are testing the Machine Protection System

    • MCRSEC_10

      public static final TimingCenter.BEAM_MODE MCRSEC_10
      The largest possible beam macro-pulse is 10 microseconds long

    • MCRSEC_50

      public static final TimingCenter.BEAM_MODE MCRSEC_50
      The largest possible beam macro-pulse is 50 microseconds long

    • MCRSEC_100

      public static final TimingCenter.BEAM_MODE MCRSEC_100
      The largest possible beam macro-pulse is 100 microseconds long

    • MILSEC_1

      public static final TimingCenter.BEAM_MODE MILSEC_1
      The largest possible beam macro-pulse is 1 milliseconds long

    • FULLPWR

      public static final TimingCenter.BEAM_MODE FULLPWR
      We are at full throttle - the beam can be all long as other systems allow

  • Method Details

    • values

      public static TimingCenter.BEAM_MODE[] 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 TimingCenter.BEAM_MODE 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

    • getPvValue

      public String getPvValue()
      Returns the string value of the enumeration constant.
      Returns:
      value of the PV which this enumeration constant represents
      Since:
      Nov 4, 2011

    • isPvValue

      public boolean isPvValue(String strPvVal)
      Check whether or not the given string is lexically equivalent to the PV value represented by this enumeration constant
      Parameters:
      strPvVal -
      Returns:
      true if the given string is this beam mode value, false otherwise
      Since:
      Nov 4, 2011