Package cnuphys.magfield

Enum Class FieldUnit

java.lang.Object

java.lang.Enum<FieldUnit>

cnuphys.magfield.FieldUnit

All Implemented Interfaces:

Serializable, Comparable<FieldUnit>, Constable

public enum FieldUnit
extends Enum<FieldUnit>

Units for the magnetic field in a field map file.

Version:

1.0

Author:

Dr. David Heddle, Nicole Schumacher

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
G
kG
T

Method Summary

Modifier and Type	Method	Description
static FieldUnit	fromInt(int val)	Get the field unit from an integer
static FieldUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FieldUnit[]	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

kG

public static final FieldUnit kG

G

public static final FieldUnit G

T

public static final FieldUnit T

Method Details

values

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

fromInt

public static FieldUnit fromInt(int val)

Get the field unit from an integer

Parameters:

val - the integer value

Returns:

the field unit