Package xal.tools.beam

Enum Class ProfileIndex

java.lang.Object

java.lang.Enum<ProfileIndex>

xal.tools.beam.ProfileIndex

All Implemented Interfaces:

Serializable, Comparable<ProfileIndex>, Constable

public enum ProfileIndex
extends Enum<ProfileIndex>

Enumeration of supported phase space beam profiles.

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
GAUSSIAN	Gaussian distribution - gaussian in 6D phase space
KV	Kapchinskij-Vladimirskij (or canonical) distribution - uniformly distributed on phase-space surface
NONE	No distribution profile specified - usually indicates error condition
PARABOLIC	Parabolic distribution - parabolic in 6D phase space
SEMIGAUSSIAN	Semi-Gaussian distribution - uniform in 3D configuration, gaussian in momentum
WATERBAG	Waterbag distribution - uniform in 6D phase space

Method Summary

Modifier and Type	Method	Description
static ProfileIndex	descriptorFromIndex(int index)	Get the ProfileDescriptor object have the given index value.
int	val()	Return the index value of the current ProfileDescriptor object.
static ProfileIndex	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProfileIndex[]	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

NONE

public static final ProfileIndex NONE

No distribution profile specified - usually indicates error condition

KV

public static final ProfileIndex KV

Kapchinskij-Vladimirskij (or canonical) distribution - uniformly distributed on phase-space surface

WATERBAG

public static final ProfileIndex WATERBAG

Waterbag distribution - uniform in 6D phase space

PARABOLIC

public static final ProfileIndex PARABOLIC

Parabolic distribution - parabolic in 6D phase space

SEMIGAUSSIAN

public static final ProfileIndex SEMIGAUSSIAN

Semi-Gaussian distribution - uniform in 3D configuration, gaussian in momentum

GAUSSIAN

public static final ProfileIndex GAUSSIAN

Gaussian distribution - gaussian in 6D phase space

Method Details

values

public static ProfileIndex[] 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 ProfileIndex 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

descriptorFromIndex

public static ProfileIndex descriptorFromIndex(int index)

Get the ProfileDescriptor object have the given index value.

Parameters:

index - index of desired profile descriptor object

Returns:

profile descriptor object have the given index

val

public int val()

Return the index value of the current ProfileDescriptor object.

Returns:

profile index value