xal.tools.beam

Enum PhaseVector.IND

java.lang.Object

java.lang.Enum<PhaseVector.IND>

xal.tools.beam.PhaseVector.IND

All Implemented Interfaces:

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

Enclosing class:

PhaseVector

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

Enumeration for the element position indices for homogeneous phase space objects. This set include the phase space coordinates and the homogeneous coordinate.

Since:

Oct 8, 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 momenutum) coordinate

Field Summary

Fields

Modifier and Type	Field and Description
int	val The numerical value of this enumeration index

Method Summary

Modifier and Type	Method and Description
int	val() Returns the numerical index of this enumeration constant, corresponding to the index into the phase matrix.
static PhaseVector.IND	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PhaseVector.IND[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static java.util.EnumSet<PhaseVector.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 PhaseVector.IND X

Index of the x coordinate

Xp

public static final PhaseVector.IND Xp

Index of the X' coordinate

Y

public static final PhaseVector.IND Y

Index of the Y coordinate

Yp

public static final PhaseVector.IND Yp

Index of the Y' coordinate

Z

public static final PhaseVector.IND Z

Index of the Z (longitudinal) coordinate

Zp

public static final PhaseVector.IND Zp

Index of the Z' (change in momenutum) coordinate

HOM

public static final PhaseVector.IND HOM

Index of the homogeneous coordinate

Field Detail

val

public final int val

The numerical value of this enumeration index

Method Detail

values

public static PhaseVector.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 (PhaseVector.IND c : PhaseVector.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 PhaseVector.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<PhaseVector.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()

Returns the numerical index of this enumeration constant, corresponding to the index into the phase matrix.

Specified by:

val in interface IIndex

Returns:

numerical value of this index

Since:

Sep 25, 2013