xal.extension.widgets.olmplot

Enum PLANE

java.lang.Object

java.lang.Enum<PLANE>

xal.extension.widgets.olmplot.PLANE

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PLANE>

public enum PLANE
extends java.lang.Enum<PLANE>

Enumeration of all the phase planes for the simulation. There is an RMS envelope value for each plane.

Since:

Nov 26, 2012

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOR Enumeration for the horizontal plane
LNG Enumeration representing the longitudinal plane
VER Enumeration representing the vertical plane

Method Summary

Modifier and Type	Method and Description
java.awt.Color	getColor() Return the color associated with this phase plane.
double	getParticlePos(ParticleProbeState state) Extracts the particle position of the phase plane represented by this enumeration constant from the given particle probe state.
double	getRmsEnvelope(EnvelopeProbeState state) Extracts the RMS envelope size of the phase plane represented by this enumeration constant from the given envelope probe state.
static PLANE	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PLANE[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

public static PLANE[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PLANE c : PLANE.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PLANE valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getColor

public java.awt.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