net.talvi.puffinplot.data

Enum RpiEstimateType

java.lang.Object

java.lang.Enum<RpiEstimateType>

net.talvi.puffinplot.data.RpiEstimateType

All Implemented Interfaces:

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

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

The parameter used in normalizing an NRM to produce an RPI estimate.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARM_DEMAG ARM demagnetization
ARM_MAG ARM magnetization
IRM_DEMAG IRM demagnetization
MAG_SUS Magnetic susceptibility

Method Summary

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

MAG_SUS

public static final RpiEstimateType MAG_SUS

Magnetic susceptibility

ARM_DEMAG

public static final RpiEstimateType ARM_DEMAG

ARM demagnetization

IRM_DEMAG

public static final RpiEstimateType IRM_DEMAG

IRM demagnetization

ARM_MAG

public static final RpiEstimateType ARM_MAG

ARM magnetization

Method Detail

values

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

Returns:

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

valueOf

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

getNiceName

public java.lang.String getNiceName()

Returns:

a user-friendly name for this estimate type