Package xal.model.alg

Enum Class EnvelopeTrackerBase.PhasePlane

java.lang.Object

java.lang.Enum<EnvelopeTrackerBase.PhasePlane>

xal.model.alg.EnvelopeTrackerBase.PhasePlane

All Implemented Interfaces:

Serializable, Comparable<EnvelopeTrackerBase.PhasePlane>, Constable

Enclosing class:

EnvelopeTrackerBase

public static enum EnvelopeTrackerBase.PhasePlane
extends Enum<EnvelopeTrackerBase.PhasePlane>

Enumerations for supported phase planes

Since:

Feb 19, 2009

Author:

Christopher K. Allen

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LONGITUDINAL	The longitudinal phase plane z
TRANSVERSE	Either transverse phase plane: horizontal x or vertical y.

Method Summary

Modifier and Type	Method	Description
int	val()	Return the integer value of the index position
static EnvelopeTrackerBase.PhasePlane	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnvelopeTrackerBase.PhasePlane[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRANSVERSE

public static final EnvelopeTrackerBase.PhasePlane TRANSVERSE

Either transverse phase plane: horizontal x or vertical y.

LONGITUDINAL

public static final EnvelopeTrackerBase.PhasePlane LONGITUDINAL

The longitudinal phase plane z

Method Details

values

public static EnvelopeTrackerBase.PhasePlane[] 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 EnvelopeTrackerBase.PhasePlane 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

val

public int val()

Return the integer value of the index position

Returns:

Integer value of enumeration constant