xal.tools.beam

Enum PhaseMatrix.IND

java.lang.Object

java.lang.Enum<PhaseMatrix.IND>

xal.tools.beam.PhaseMatrix.IND

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PhaseMatrix.IND>, IIndex

Enclosing class:

PhaseMatrix

public static enum PhaseMatrix.IND
extends java.lang.Enum<PhaseMatrix.IND>
implements IIndex

Enumeration for the element position indices of a homogeneous phase space objects. Extends the PhaseIndex class by adding the homogeneous element position HOM.

Since:

Oct, 2013

Enum Constant Summary

Enum Constants

Enum Constant and Description
HOM Index of the homogeneous coordinate
X Index of the x coordinate
Xp Index of the X' coordinate
Y Index of the Y coordinate
Yp Index of the Y' coordinate
Z Index of the Z (longitudinal) coordinate
Zp Index of the Z' (change in momentum) coordinate

Method Summary

Modifier and Type	Method and Description
int	val() Return the integer value of the index position
static PhaseMatrix.IND	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PhaseMatrix.IND[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static java.util.EnumSet<PhaseMatrix.IND>	valuesPhase() Returns the set of index constants that correspond to phase coordinates only.

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

X

public static final PhaseMatrix.IND X

Index of the x coordinate

Xp

public static final PhaseMatrix.IND Xp

Index of the X' coordinate

Y

public static final PhaseMatrix.IND Y

Index of the Y coordinate

Yp

public static final PhaseMatrix.IND Yp

Index of the Y' coordinate

Z

public static final PhaseMatrix.IND Z

Index of the Z (longitudinal) coordinate

Zp

public static final PhaseMatrix.IND Zp

Index of the Z' (change in momentum) coordinate

HOM

public static final PhaseMatrix.IND HOM

Index of the homogeneous coordinate

Method Detail

values

public static PhaseMatrix.IND[] 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 (PhaseMatrix.IND c : PhaseMatrix.IND.values())
    System.out.println(c);

Returns:

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

valueOf

public static PhaseMatrix.IND 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

valuesPhase

public static java.util.EnumSet<PhaseMatrix.IND> valuesPhase()

Returns the set of index constants that correspond to phase coordinates only. The homogeneous coordinate index is not included (i.e., the IND.HOM constant).

Returns:

the set of phase indices IND less the HOM constant

Since:

Oct 15, 2013

See Also:

xal.tools.math.BaseMatrix.IIndex#val()

val

public int val()

Return the integer value of the index position

Specified by:

val in interface IIndex

Returns:

the numerical index represented by this object