xal.smf.impl.profile

Enum ProfileDevice.MACROPULSE

java.lang.Object

java.lang.Enum<ProfileDevice.MACROPULSE>

xal.smf.impl.profile.ProfileDevice.MACROPULSE

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProfileDevice.MACROPULSE>

Enclosing class:

ProfileDevice

public static enum ProfileDevice.MACROPULSE
extends java.lang.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

Enum Constant Summary

Enum Constants

Enum Constant and 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 and Description
static ProfileDevice.MACROPULSE	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProfileDevice.MACROPULSE[]	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

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 Detail

values

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

Returns:

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

valueOf

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