Module org.opengis.geoapi

Package org.opengis.referencing.datum

Class VerticalDatumType

Object

CodeList<VerticalDatumType>

VerticalDatumType

All Implemented Interfaces:

Serializable, Comparable<VerticalDatumType>, ControlledVocabulary

@Deprecated(since="3.1")
@UML(identifier="CD_VerticalDatumType",
     specification=ISO_19111,
     version=2003)
public final class VerticalDatumType
extends CodeList<VerticalDatumType>

Deprecated.

Replaced by RealizationMethod in ISO 19111:2019.

Type of a vertical datum. Note that ISO 19111 omits the definition of an ELLIPSOIDAL vertical height on intent. GeographicCRS with ellipsoidal height shall be backed by a three-dimensional EllipsoidalCS; they should not be built as CompoundCRS.

Since:

1.0

See Also:

• VerticalDatum.getVerticalDatumType()
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final VerticalDatumType	BAROMETRIC	Deprecated. The origin of the vertical axis is based on atmospheric pressure.
static final VerticalDatumType	DEPTH	Deprecated. The zero point is defined by a surface that has meaning for the purpose which the associated vertical measurements are used for.
static final VerticalDatumType	GEOIDAL	Deprecated. The zero value is defined to approximate a constant potential surface, usually the geoid.
static final VerticalDatumType	OTHER_SURFACE	Deprecated. The zero value is defined by a method not described by the other enumeration values in this class.

Method Summary

Modifier and Type	Method	Description
VerticalDatumType[]	family()	Deprecated. Returns the list of codes of the same kind as this code list element.
static VerticalDatumType	valueOf(String code)	Deprecated. Returns the vertical datum type that matches the given string, or returns a new one if none match it.
static VerticalDatumType[]	values()	Deprecated. Returns the list of VerticalDatumTypes.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

OTHER_SURFACE

@UML(identifier="other surface",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final VerticalDatumType OTHER_SURFACE

Deprecated.

The zero value is defined by a method not described by the other enumeration values in this class. In some cases, for example oil exploration and production, a geological feature, such as the top or bottom of a geologically identifiable and meaningful subsurface layer, is used as a vertical datum. Other variations to the above three vertical datum types may exist and are all included in this type.

GEOIDAL

@UML(identifier="geoidal",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final VerticalDatumType GEOIDAL

Deprecated.

The zero value is defined to approximate a constant potential surface, usually the geoid. Such a reference surface is usually determined by a national or scientific authority, and is then a well-known, named reference frame.

DEPTH

@UML(identifier="depth",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final VerticalDatumType DEPTH

Deprecated.

The zero point is defined by a surface that has meaning for the purpose which the associated vertical measurements are used for. For hydrographic charts, this is often a predicted nominal sea surface (i.e., without waves or other wind and current effects) that occurs at low tide. Examples are Lowest Astronomical Tide and Lowest Low Water Spring. A different example is a sloping and undulating River Datum defined as the nominal river water surface occurring at a quantified river discharge.

Depths are measured in the direction perpendicular (approximately) to the actual equipotential surfaces of the planet's gravity field, using such procedures as echo-sounding.

BAROMETRIC

@UML(identifier="barometric",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final VerticalDatumType BAROMETRIC

Deprecated.

The origin of the vertical axis is based on atmospheric pressure. Atmospheric pressure may be used as the intermediary to determine height (barometric height determination) or it may be used directly as the vertical coordinate, against which other parameters are measured. Barometric values are usually expressed in one of the following units: meters, feet, millibars (used to measure pressure levels), or theta value (units used to measure geopotential height).

Method Details

values

public static VerticalDatumType[] values()

Deprecated.

Returns the list of VerticalDatumTypes.

Returns:

the list of codes declared in the current JVM.

family

public VerticalDatumType[] family()

Deprecated.

Returns the list of codes of the same kind as this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<VerticalDatumType>

Returns:

all code values for this code list.

valueOf

public static VerticalDatumType valueOf(String code)

Deprecated.

Returns the vertical datum type that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.