xal.tools.beam

Enum Twiss.PROP

java.lang.Object

java.lang.Enum<Twiss.PROP>

xal.tools.beam.Twiss.PROP

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Twiss.PROP>

Enclosing class:

Twiss

public static enum Twiss.PROP
extends java.lang.Enum<Twiss.PROP>

Enumeration of the Courant-Snyder parameters used. Intended for expediting display of these parameters.

Since:

Oct 2, 2014

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHA The Courant-Snyder alpha parameter
BETA The Courant-Snyder beta parameter
EMIT The Courant-Snyder emittance

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPropertyLabel() Returns the label of the property in the data structure which corresponds to this enumeration constant.
double	getPropertyValue(Twiss data) Using reflection, we return the value of the field that this enumeration constant represents, within the given data structure.
static Twiss.PROP	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Twiss.PROP[]	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

ALPHA

public static final Twiss.PROP ALPHA

The Courant-Snyder alpha parameter

BETA

public static final Twiss.PROP BETA

The Courant-Snyder beta parameter

EMIT

public static final Twiss.PROP EMIT

The Courant-Snyder emittance

Method Detail

values

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

Returns:

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

valueOf

public static Twiss.PROP 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

getPropertyLabel

public java.lang.String getPropertyLabel()

Returns the label of the property in the data structure which corresponds to this enumeration constant.

Returns:

property label

Since:

Nov 13, 2009

getPropertyValue

public double getPropertyValue(Twiss data)

Using reflection, we return the value of the field that this enumeration constant represents, within the given data structure.

Parameters:

data - Twiss data structure having field corresponding to this constant

Returns:

value of the given data structure's field

Since:

Apr 22, 2010