Module simpa.acc

Package simpa.acc.api

Enum Class BeamDistribution

java.lang.Object

java.lang.Enum<BeamDistribution>

simpa.acc.api.BeamDistribution

All Implemented Interfaces:

Serializable, Comparable<BeamDistribution>, Constable

public enum BeamDistribution
extends Enum<BeamDistribution>

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
ELLIPSE	Particles placed into a given phase space ellipse
GAUSSIAN	Gaussian beam distribution

Method Summary

Modifier and Type	Method	Description
static BeamDistribution	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BeamDistribution[]	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

GAUSSIAN

public static final BeamDistribution GAUSSIAN

Gaussian beam distribution

ELLIPSE

public static final BeamDistribution ELLIPSE

Particles placed into a given phase space ellipse

Method Details

values

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