Package xal.tools.math.r4

Enum Class R4x4.IND

java.lang.Object

java.lang.Enum<R4x4.IND>

xal.tools.math.r4.R4x4.IND

All Implemented Interfaces:

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

Enclosing class:

R4x4

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

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
X1	Index of the 1st coordinate
X2	Index of the 2nd coordinate
X3	Index of the 3rd coordinate
X4	Index of the 4th coordinate

Method Summary

Modifier and Type	Method	Description
int	val()	Return the integer value of the index position
static R4x4.IND	valueOf(String name)	Returns the enum constant of this class with the specified name.
static R4x4.IND[]	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

X1

public static final R4x4.IND X1

Index of the 1st coordinate

X2

public static final R4x4.IND X2

Index of the 2nd coordinate

X3

public static final R4x4.IND X3

Index of the 3rd coordinate

X4

public static final R4x4.IND X4

Index of the 4th coordinate

Method Details

values

public static R4x4.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 R4x4.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

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