xal.tools.beam

Enum Twiss3D.IND_3D

java.lang.Object

java.lang.Enum<Twiss3D.IND_3D>

xal.tools.beam.Twiss3D.IND_3D

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Twiss3D.IND_3D>, IIndex

Enclosing class:

Twiss3D

public static enum Twiss3D.IND_3D
extends java.lang.Enum<Twiss3D.IND_3D>
implements IIndex

Enumeration for the element position indices of three-dimensional objects.

Enum Constant Summary

Enum Constants

Enum Constant and Description
X The horizontal axis
Y The vertical axis
Z The longitudinal axis

Method Summary

Modifier and Type	Method and Description
int	val() Return the integer value of the index position
static Twiss3D.IND_3D	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Twiss3D.IND_3D[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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 Twiss3D.IND_3D X

The horizontal axis

Y

public static final Twiss3D.IND_3D Y

The vertical axis

Z

public static final Twiss3D.IND_3D Z

The longitudinal axis

Method Detail

values

public static Twiss3D.IND_3D[] 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 (Twiss3D.IND_3D c : Twiss3D.IND_3D.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Twiss3D.IND_3D 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

val

public int val()

Return the integer value of the index position

Specified by:

val in interface IIndex

Returns:

Integer value of enumeration constant