Package xal.tools.math.r2

Enum Class R2x2.IND

java.lang.Object

java.lang.Enum<R2x2.IND>

xal.tools.math.r2.R2x2.IND

All Implemented Interfaces:

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

Enclosing class:

R2x2

public static enum R2x2.IND
extends Enum<R2x2.IND>
implements IIndex

Enumeration of the allowed index positions for objects of type R2x2.

Since:

Oct 2, 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
P	represents the phase angle index
X	represents the phase coordinate index

Method Summary

Modifier and Type	Method	Description
int	val()	Returns the numerical value of this index enumeration constant.
static R2x2.IND	valueOf(String name)	Returns the enum constant of this class with the specified name.
static R2x2.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

X

public static final R2x2.IND X

represents the phase coordinate index

P

public static final R2x2.IND P

represents the phase angle index

Method Details

values

public static R2x2.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 R2x2.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()

Returns the numerical value of this index enumeration constant.

Specified by:

val in interface IIndex

Returns:

numerical index value

Since:

Sep 27, 2013

See Also:

• xal.tools.math.SquareMatrix.IIndex#val()