net.talvi.puffinplot.data.file
Enum TwoGeeLoader.Protocol

java.lang.Object
  extended by java.lang.Enum<TwoGeeLoader.Protocol>
      extended by net.talvi.puffinplot.data.file.TwoGeeLoader.Protocol
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<TwoGeeLoader.Protocol>
Enclosing class:
TwoGeeLoader

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

A measurement protocol. A protocol defines the order in which sample measurements and empty-tray measurements are taken, and the sample orientations during sample measurements.


Enum Constant Summary
NORMAL
          just a sample measurement
NORMAL_TRAY
          sample measurement then tray measurement
TRAY_FIRST
          single initial tray measurement, then sample measurements
TRAY_NORMAL
          tray measurement then sample measurement
TRAY_NORMAL_IGNORE
          as TRAY_NORMAL but only use first tray correction
TRAY_NORMAL_YFLIP
          tray, then sample, then sample flipped around Y axis
 
Method Summary
static TwoGeeLoader.Protocol valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static TwoGeeLoader.Protocol[] 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

NORMAL

public static final TwoGeeLoader.Protocol NORMAL
just a sample measurement


TRAY_NORMAL

public static final TwoGeeLoader.Protocol TRAY_NORMAL
tray measurement then sample measurement


NORMAL_TRAY

public static final TwoGeeLoader.Protocol NORMAL_TRAY
sample measurement then tray measurement


TRAY_NORMAL_YFLIP

public static final TwoGeeLoader.Protocol TRAY_NORMAL_YFLIP
tray, then sample, then sample flipped around Y axis


TRAY_FIRST

public static final TwoGeeLoader.Protocol TRAY_FIRST
single initial tray measurement, then sample measurements


TRAY_NORMAL_IGNORE

public static final TwoGeeLoader.Protocol TRAY_NORMAL_IGNORE
as TRAY_NORMAL but only use first tray correction

Method Detail

values

public static TwoGeeLoader.Protocol[] 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.Protocol c : TwoGeeLoader.Protocol.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.Protocol 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