Package xal.smf.impl.profile

Enum Class ProfileDevice.MACROPULSE

java.lang.Object

java.lang.Enum<ProfileDevice.MACROPULSE>

xal.smf.impl.profile.ProfileDevice.MACROPULSE

All Implemented Interfaces:

Serializable, Comparable<ProfileDevice.MACROPULSE>, Constable

Enclosing class:

ProfileDevice

public static enum ProfileDevice.MACROPULSE
extends Enum<ProfileDevice.MACROPULSE>

Sections of the beam used by the analysis parameter selection methods for setting which part of the acquired beam is used for computing the sample values.

Since:

Nov 16, 2011

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
ALL	All of the beam pulse
BODY	The body of the beam
HEAD	The head of the beam
TAIL	The tail of the beam

Method Summary

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

HEAD

public static final ProfileDevice.MACROPULSE HEAD

The head of the beam

BODY

public static final ProfileDevice.MACROPULSE BODY

The body of the beam

TAIL

public static final ProfileDevice.MACROPULSE TAIL

The tail of the beam

ALL

public static final ProfileDevice.MACROPULSE ALL

All of the beam pulse

Method Details

values

public static ProfileDevice.MACROPULSE[] 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 ProfileDevice.MACROPULSE 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