Package xal.tools.beam

Enum Class PhaseIndex

java.lang.Object

java.lang.Enum<PhaseIndex>

xal.tools.beam.PhaseIndex

All Implemented Interfaces:

Serializable, Comparable<PhaseIndex>, Constable, IIndex

public enum PhaseIndex
extends Enum<PhaseIndex>
implements IIndex

Enumeration for the element position indices of six-dimensional phase space object.

Version:

Nov 12, 2013

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
X
XP
Y
YP
Z
ZP

Method Summary

Modifier and Type	Method	Description
PhaseIndex	conjugate()	Return the conjugate variable index to this.
static Set<PhaseIndex>	momentumIndices()	Return the set of indices corresponding to momentum coordinates.
static Set<PhaseIndex>	spatialIndices()	Return the set of indices corresponding to spatial coordinates.
int	val()	Return the integer value of the index position
static PhaseIndex	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PhaseIndex[]	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

X

public static final PhaseIndex X

XP

public static final PhaseIndex XP

Y

public static final PhaseIndex Y

YP

public static final PhaseIndex YP

Z

public static final PhaseIndex Z

ZP

public static final PhaseIndex ZP

Method Details

values

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

spatialIndices

public static Set<PhaseIndex> spatialIndices()

Return the set of indices corresponding to spatial coordinates.

Returns:

set of spatial indices

momentumIndices

public static Set<PhaseIndex> momentumIndices()

Return the set of indices corresponding to momentum coordinates.

Returns:

set of momentum indices

val

public int val()

Return the integer value of the index position

Specified by:

val in interface IIndex

Returns:

value of this index

conjugate

public PhaseIndex conjugate()

Return the conjugate variable index to this. NOTE: - This function is highly under-optimized.

Returns:

conjugate variable index