Package xal.extension.wirescan.profile

Enum Class ProfileData.Angle

java.lang.Object

java.lang.Enum<ProfileData.Angle>

xal.extension.wirescan.profile.ProfileData.Angle

All Implemented Interfaces:

Serializable, Comparable<ProfileData.Angle>, Constable

Enclosing class:

ProfileData

public static enum ProfileData.Angle
extends Enum<ProfileData.Angle>

Enumeration of supported projection-data view angles. Typically these values are used as method arguments identifying the projection data under consideration.

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
DIA	Diagonal projection
HOR	Horizontal projection
VER	Vertical projection

Method Summary

Modifier and Type	Method	Description
static int	getCount()	Return the total number of supported viewing angles.
int	getIndex()	Return the array index associated with the view angle.
static ProfileData.Angle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ProfileData.Angle[]	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

HOR

public static final ProfileData.Angle HOR

Horizontal projection

VER

public static final ProfileData.Angle VER

Vertical projection

DIA

public static final ProfileData.Angle DIA

Diagonal projection

Method Details

values

public static ProfileData.Angle[] 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 ProfileData.Angle 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

getCount

public static int getCount()

Return the total number of supported viewing angles.

Returns:

number of view angles

getIndex

public int getIndex()

Return the array index associated with the view angle.

Returns:

index associated with this view