no.petroware.jwitsml.model

Enum WitsmlWell.Datum.Type

java.lang.Object

java.lang.Enum<WitsmlWell.Datum.Type>

no.petroware.jwitsml.model.WitsmlWell.Datum.Type

All Implemented Interfaces:

Serializable, Comparable<WitsmlWell.Datum.Type>

Enclosing class:

WitsmlWell.Datum

public static enum WitsmlWell.Datum.Type
extends Enum<WitsmlWell.Datum.Type>

The type of local or permanent reference datum for vertical gravity based (i.e., elevation and vertical depth) and measured depth coordinates within the context of a well. This list includes local points (e.g., kelly bushing) used as a datum and vertical reference datums (e.g., mean sea level).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CASING_FLANGE Casing flange: A flange affixed to the top of the casing string used to attach production equipment.
CROWN_VALVE Crown valve.
DERRICK_FLOOR Derrick floor.
GROUND_LEVEL Ground level.
KELLY_BUSHING Kelly bushing.
KICKOFF_POINT Kickoff point.
LOWEST_ASTRONOMICAL_TIDE Lowest Astronomical Tide.
MEAN_HIGH_WATER Mean High Water - A tidal datum.
MEAN_HIGHER_HIGH_WATER Mean Higher High Water - A tidal datum.
MEAN_LOW_WATER Mean Low Water - A tidal datum.
MEAN_LOWER_LOW_WATER Mean Lower Low Water - A tidal datum.
MEAN_SEA_LEVEL Mean Sea Level - A tidal datum.
MEAN_TIDE_LEVEL Mean Tide Level - A tidal datum.
ROTARY_BUSHING Rotary bushing.
ROTARY_TABLE Rotary table.
SEA_FLOOR Sea floor.
UNKNOWN The value is not known.

Method Summary

Modifier and Type	Method and Description
static WitsmlWell.Datum.Type	get(String tag) Return enumeration value for the specified string tag.
String	toString()
static WitsmlWell.Datum.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static WitsmlWell.Datum.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CASING_FLANGE

public static final WitsmlWell.Datum.Type CASING_FLANGE

Casing flange: A flange affixed to the top of the casing string used to attach production equipment.

CROWN_VALVE

public static final WitsmlWell.Datum.Type CROWN_VALVE

Crown valve.

DERRICK_FLOOR

public static final WitsmlWell.Datum.Type DERRICK_FLOOR

Derrick floor.

GROUND_LEVEL

public static final WitsmlWell.Datum.Type GROUND_LEVEL

Ground level.

KELLY_BUSHING

public static final WitsmlWell.Datum.Type KELLY_BUSHING

Kelly bushing.

ROTARY_BUSHING

public static final WitsmlWell.Datum.Type ROTARY_BUSHING

Rotary bushing.

ROTARY_TABLE

public static final WitsmlWell.Datum.Type ROTARY_TABLE

Rotary table.

SEA_FLOOR

public static final WitsmlWell.Datum.Type SEA_FLOOR

Sea floor.

LOWEST_ASTRONOMICAL_TIDE

public static final WitsmlWell.Datum.Type LOWEST_ASTRONOMICAL_TIDE

Lowest Astronomical Tide. The lowest tide level over the duration of the National Tidal Datum Epoch (19 years).

MEAN_SEA_LEVEL

public static final WitsmlWell.Datum.Type MEAN_SEA_LEVEL

Mean Sea Level - A tidal datum. The arithmetic mean of hourly heights observed over the National Tidal Datum Epoch (19 years).

MEAN_HIGHER_HIGH_WATER

public static final WitsmlWell.Datum.Type MEAN_HIGHER_HIGH_WATER

Mean Higher High Water - A tidal datum. The average of the higher high water height of each tidal day observed over the National Tidal Datum Epoch (19 years).

MEAN_HIGH_WATER

public static final WitsmlWell.Datum.Type MEAN_HIGH_WATER

Mean High Water - A tidal datum. The average of all the high water heights observed over the National Tidal Datum Epoch (19 years).

MEAN_LOWER_LOW_WATER

public static final WitsmlWell.Datum.Type MEAN_LOWER_LOW_WATER

Mean Lower Low Water - A tidal datum. The average of the lower low water height of each tidal day observed over the National Tidal Datum Epoch (19 years ).

MEAN_LOW_WATER

public static final WitsmlWell.Datum.Type MEAN_LOW_WATER

Mean Low Water - A tidal datum. The average of all the low water heights observed over the National Tidal Datum Epoch (19 years).

MEAN_TIDE_LEVEL

public static final WitsmlWell.Datum.Type MEAN_TIDE_LEVEL

Mean Tide Level - A tidal datum. The arithmetic mean of mean high water and mean low water. Same as half-tide level.

KICKOFF_POINT

public static final WitsmlWell.Datum.Type KICKOFF_POINT

Kickoff point.

UNKNOWN

public static final WitsmlWell.Datum.Type UNKNOWN

The value is not known. This value should not be used in normal situations. All reasonable attempts should be made to determine the appropriate value. Use of this value may result in rejection in some situations.

Method Detail

values

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

Returns:

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

valueOf

public static WitsmlWell.Datum.Type valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<WitsmlWell.Datum.Type>

get

public static WitsmlWell.Datum.Type get(String tag)

Return enumeration value for the specified string tag.

Parameters:

tag - String tag to get value of. Non-null.

Returns:

Requested value or null if not found.