Package cnuphys.magfield

Enum Class CoordinateSystem

java.lang.Object

java.lang.Enum<CoordinateSystem>

cnuphys.magfield.CoordinateSystem

All Implemented Interfaces:

Serializable, Comparable<CoordinateSystem>, Constable

public enum CoordinateSystem
extends Enum<CoordinateSystem>

Different coordinate systems for either field or grid, for data in field map files.

Version:

1.0

Author:

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
CARTESIAN
CYLINDRICAL

Method Summary

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

CYLINDRICAL

public static final CoordinateSystem CYLINDRICAL

CARTESIAN

public static final CoordinateSystem CARTESIAN

Method Details

values

public static CoordinateSystem[] 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 CoordinateSystem 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 CoordinateSystem fromInt(int val)

Get the coordinate system from an integer

Parameters:

val - the integer value

Returns:

the coordinate system