net.talvi.puffinplot.data

Enum Correction.Rotation

java.lang.Object

java.lang.Enum<Correction.Rotation>

net.talvi.puffinplot.data.Correction.Rotation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Correction.Rotation>

Enclosing class:

Correction

public static enum Correction.Rotation
extends java.lang.Enum<Correction.Rotation>

An enumeration of the types of rotation correction which may be applied to a sample's data.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FORMATION data rotated to correct for sample and formation orientation
NONE no rotation applied to data
SAMPLE data rotated to correct for sample orientation

Method Summary

Modifier and Type	Method and Description
java.lang.String	getNiceName() Returns a user-friendly name for this rotation correction.
static Correction.Rotation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Correction.Rotation[]	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 Correction.Rotation NONE

no rotation applied to data

SAMPLE

public static final Correction.Rotation SAMPLE

data rotated to correct for sample orientation

FORMATION

public static final Correction.Rotation FORMATION

data rotated to correct for sample and formation orientation

Method Detail

values

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

Returns:

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

valueOf

public static Correction.Rotation 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 rotation correction.

Returns:

a user-friendly name for this rotation correction