Package xal.extension.widgets.olmplot

Enum Class PLANE

java.lang.Object
java.lang.Enum<PLANE>
xal.extension.widgets.olmplot.PLANE
All Implemented Interfaces:
Serializable, Comparable<PLANE>, Constable
public enum PLANE extends Enum<PLANE>
Enumeration of all the phase planes for the simulation. There is an RMS envelope value for each plane.
Since:
Nov 26, 2012
Author:
Christopher K. Allen

  • Enum Constant Details

    • HOR

      public static final PLANE HOR
      Enumeration for the horizontal plane

    • VER

      public static final PLANE VER
      Enumeration representing the vertical plane

    • LNG

      public static final PLANE LNG
      Enumeration representing the longitudinal plane

  • Method Details

    • values

      public static PLANE[] 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 PLANE 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

    • getColor

      public Color getColor()
      Return the color associated with this phase plane.
      Returns:
      default color for the phase plane
      Since:
      Nov 26, 2012

    • getParticlePos

      public double getParticlePos(ParticleProbeState state)
      Extracts the particle position of the phase plane represented by this enumeration constant from the given particle probe state.
      Parameters:
      state - ParticleProbeState object containing particle state information
      Returns:
      the value of the RMS envelope of this phase plane within the given state
      Since:
      Nov 26, 2012

    • getRmsEnvelope

      public double getRmsEnvelope(EnvelopeProbeState state)
      Extracts the RMS envelope size of the phase plane represented by this enumeration constant from the given envelope probe state.
      Parameters:
      state - EnvelopeProbeState object containing RMS envelope information
      Returns:
      the value of the RMS envelope of this phase plane within the given state
      Since:
      Nov 26, 2012