net.talvi.puffinplot.data.file

Enum TwoGeeLoader.MomentFields

java.lang.Object

java.lang.Enum<TwoGeeLoader.MomentFields>

net.talvi.puffinplot.data.file.TwoGeeLoader.MomentFields

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TwoGeeLoader.MomentFields>

Enclosing class:

TwoGeeLoader

public static enum TwoGeeLoader.MomentFields
extends java.lang.Enum<TwoGeeLoader.MomentFields>

The fields from which to read the magnetic moment (Cartesian or Polar). Crucially, in a 2G continuous file the polar fields are corrected for sensor length but the Cartesian fields are not, so if the sensor lengths are unknown it is vital to use polar fields when reading a continuous file.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CARTESIAN X / Y / Z
POLAR Declination / inclination / intensity

Method Summary

Modifier and Type	Method and Description
static TwoGeeLoader.MomentFields	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TwoGeeLoader.MomentFields[]	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

CARTESIAN

public static final TwoGeeLoader.MomentFields CARTESIAN

X / Y / Z

POLAR

public static final TwoGeeLoader.MomentFields POLAR

Declination / inclination / intensity

Method Detail

values

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

Returns:

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

valueOf

public static TwoGeeLoader.MomentFields 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