net.talvi.puffinplot.data
Enum TreatType

java.lang.Object
  extended by java.lang.Enum<TreatType>
      extended by net.talvi.puffinplot.data.TreatType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TreatType>

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

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


Enum Constant Summary
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
 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 involvesAf()
           
static TreatType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TreatType[] 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 TreatType NONE
no treatment applied


DEGAUSS_XYZ

public static final TreatType DEGAUSS_XYZ
static alternating-field treatment along three orthogonal axes


DEGAUSS_Z

public static final TreatType DEGAUSS_Z
static alternating-field treatment along one axis


ARM

public static final TreatType ARM
anhysteretic remanent magnetization: alternating-field treatment with a DC biasing field


IRM

public static final TreatType IRM
isothermal remanent magnetization: a pulsed non-alternating field


THERMAL

public static final TreatType THERMAL
heating


UNKNOWN

public static final TreatType UNKNOWN
unknown treatment type

Method Detail

values

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

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

valueOf

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

involvesAf

public boolean involvesAf()
Returns:
true if this treatment involves application of an alternating magnetic field