Module simpa.acc

Package simpa.acc.api.track

Enum Class PhaseSpacePlane

java.lang.Object

java.lang.Enum<PhaseSpacePlane>

simpa.acc.api.track.PhaseSpacePlane

All Implemented Interfaces:

Serializable, Comparable<PhaseSpacePlane>, Constable

public enum PhaseSpacePlane
extends Enum<PhaseSpacePlane>

Enum for the different types of phase space planes.

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
HORIZONTAL	Horizontal phase space plane.
LONGITUDINAL	Longitudinal phase space plane.
VERTICAL	Vertical phase space plane.

Method Summary

Modifier and Type	Method	Description
static PhaseSpacePlane	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PhaseSpacePlane[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HORIZONTAL

public static final PhaseSpacePlane HORIZONTAL

Horizontal phase space plane.

VERTICAL

public static final PhaseSpacePlane VERTICAL

Vertical phase space plane.

LONGITUDINAL

public static final PhaseSpacePlane LONGITUDINAL

Longitudinal phase space plane.

Method Details

values

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