net.talvi.puffinplot.data

Enum ArmAxis

java.lang.Object

java.lang.Enum<ArmAxis>

net.talvi.puffinplot.data.ArmAxis

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ArmAxis>

public enum ArmAxis
extends java.lang.Enum<ArmAxis>

ArmAxis represents the axis along which an ARM (anhysteretic remanent magnetization) field has been applied.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AXIAL an ARM axis lying along the axis of the magnetometer
NONE no ARM was applied
UNKNOWN the ARM axis is unknown, or cannot be represented by this enum

Method Summary

Modifier and Type	Method and Description
static ArmAxis	fromString(java.lang.String name) Creates an ArmAxis from the supplied string.
static ArmAxis	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ArmAxis[]	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

AXIAL

public static final ArmAxis AXIAL

an ARM axis lying along the axis of the magnetometer

NONE

public static final ArmAxis NONE

no ARM was applied

UNKNOWN

public static final ArmAxis UNKNOWN

the ARM axis is unknown, or cannot be represented by this enum

Method Detail

values

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

Returns:

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

valueOf

public static ArmAxis 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

fromString

public static ArmAxis fromString(java.lang.String name)

Creates an ArmAxis from the supplied string. The values produced are as follows:

ArmAxis values

Input	Result
AXIAL	AXIAL
NONE	NONE
NA	NONE
[any other string]	UNKNOWN

Parameters:

name - a string specifying the ARM axis

Returns:

the ARM axis specified by the supplied string