net.talvi.puffinplot.data

Enum TreatmentType

java.lang.Object

java.lang.Enum<TreatmentType>

net.talvi.puffinplot.data.TreatmentType

All Implemented Interfaces:

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

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

A type of treatment applied to a sample. The most common are alternating-field and heating.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARM Anhysteretic remanent magnetization: alternating-field treatment with a DC biasing field.
DEGAUSS_XYZ Static alternating-field treatment along three orthogonal axes.
DEGAUSS_Z Static alternating-field treatment along one axis.
IRM Isothermal remanent magnetization: a pulsed non-alternating field.
NONE No treatment applied.
THERMAL Heating.
UNKNOWN Unknown treatment type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAxisLabel() Returns the axis label to use when plotting a graph involving this treatment.
java.lang.String	getNiceName() Returns a user-friendly name for this treatment.
java.lang.String	getUnit() The units in which this treatment is quantified.
boolean	isMagneticField()
static TreatmentType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TreatmentType[]	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

NONE

public static final TreatmentType NONE

No treatment applied.

DEGAUSS_XYZ

public static final TreatmentType DEGAUSS_XYZ

Static alternating-field treatment along three orthogonal axes.

DEGAUSS_Z

public static final TreatmentType DEGAUSS_Z

Static alternating-field treatment along one axis.

ARM

public static final TreatmentType ARM

Anhysteretic remanent magnetization: alternating-field treatment with a DC biasing field. The associated treatment level is assumed to be the alternating-field strength rather than the bias field.

IRM

public static final TreatmentType IRM

Isothermal remanent magnetization: a pulsed non-alternating field.

THERMAL

public static final TreatmentType THERMAL

Heating.

UNKNOWN

public static final TreatmentType UNKNOWN

Unknown treatment type.

Method Detail

values

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

Returns:

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

valueOf

public static TreatmentType 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 treatment.

Returns:

a user-friendly name for this treatment

getAxisLabel

public java.lang.String getAxisLabel()

Returns the axis label to use when plotting a graph involving this treatment.

Returns:

the axis label to use when plotting a graph involving this treatment

getUnit

public java.lang.String getUnit()

The units in which this treatment is quantified.

Returns:

the units in which this treatment is quantified

isMagneticField

public boolean isMagneticField()

Returns:

true if and only if this treatment involves application of a magnetic field