Package xal.tools.beam

Enum Class EnergyVector.IND

java.lang.Object

java.lang.Enum<EnergyVector.IND>

xal.tools.beam.EnergyVector.IND

All Implemented Interfaces:

Serializable, Comparable<EnergyVector.IND>, Constable, IIndex

Enclosing class:

EnergyVector

public static enum EnergyVector.IND
extends Enum<EnergyVector.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

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
HOM	Index of the homogeneous coordinate
PHI	Index of the synchronous coordinate
W	Index of the energy coordinate

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
int	val()	Returns the numerical index of this enumeration constant, corresponding to the index into the phase vector.
static EnergyVector.IND	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnergyVector.IND[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static Set<EnergyVector.IND>	valuesSync()	Returns the set of index constants that correspond to phase coordinates only.

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

PHI

public static final EnergyVector.IND PHI

Index of the synchronous coordinate

W

public static final EnergyVector.IND W

Index of the energy coordinate

HOM

public static final EnergyVector.IND HOM

Index of the homogeneous coordinate

Field Details

value

public final int value

The numerical value of this enumeration index

Method Details

values

public static EnergyVector.IND[] 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 EnergyVector.IND 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

valuesSync

public static Set<EnergyVector.IND> valuesSync()

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 vector.

Specified by:

val in interface IIndex

Returns:

numerical value of this index

Since:

Sep 25, 2013