net.talvi.puffinplot.data.file

Enum OrientationParameters.DipParameter

java.lang.Object

java.lang.Enum<OrientationParameters.DipParameter>

net.talvi.puffinplot.data.file.OrientationParameters.DipParameter

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OrientationParameters.DipParameter>

Enclosing class:

OrientationParameters

public static enum OrientationParameters.DipParameter
extends java.lang.Enum<OrientationParameters.DipParameter>

A parameter representing an orientation convention for a vertical angular measurement (e.g. the dip of a sample core). The exact interpretation is context-dependent, but the two possible index values (0 and 90) correspond to angles measured in degrees.

Enum Constant Summary

Enum Constants

Enum Constant and Description
D0 An orientation value associated with an angle of 0 degrees.
D90 An orientation value associated with an angle of 90 degrees.

Field Summary

Fields

Modifier and Type	Field and Description
int	index An index for a possible orientation parameter value (valid values are 0 and 90).

Method Summary

Modifier and Type	Method and Description
double	correctFormationDipDirectionForP4(double original) Taking this parameter as P4, converts a formation dip direction to the "P4=0" convention.
double	correctSampleDipForP2(double original) Taking this parameter as P2, converts a dip to the "P2=90" convention.
static OrientationParameters.DipParameter	read(int index) Returns a dip parameter for a specified index.
static OrientationParameters.DipParameter	read(java.lang.String index) Parses a string as an integer and return a dip parameter with the corresponding index.
static OrientationParameters.DipParameter	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OrientationParameters.DipParameter[]	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

D0

public static final OrientationParameters.DipParameter D0

An orientation value associated with an angle of 0 degrees.

D90

public static final OrientationParameters.DipParameter D90

An orientation value associated with an angle of 90 degrees.

Field Detail

index

public final int index

An index for a possible orientation parameter value (valid values are 0 and 90).

Method Detail

values

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

Returns:

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

valueOf

public static OrientationParameters.DipParameter 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

read

public static OrientationParameters.DipParameter read(java.lang.String index)

Parses a string as an integer and return a dip parameter with the corresponding index.

Parameters:

index - a string consisting of "0" or "90", with optional surrounding whitespace

Returns:

a dip parameter with the specified index

read

public static OrientationParameters.DipParameter read(int index)

Returns a dip parameter for a specified index.

Parameters:

index - 0 or 90

Returns:

a dip parameter with the specified index

correctSampleDipForP2

public double correctSampleDipForP2(double original)

Taking this parameter as P2, converts a dip to the "P2=90" convention.

Parameters:

original - the dip according to "P2 = this object" convention

Returns:

the dip according to "P2 = 90" convention

correctFormationDipDirectionForP4

public double correctFormationDipDirectionForP4(double original)

Taking this parameter as P4, converts a formation dip direction to the "P4=0" convention.

Parameters:

original - the formation dip direction according to "P4 = this object" convention

Returns:

the formation dip direction according to "P4 = 0" convention