Module org.opengis.geoapi
Package org.opengis.referencing.datum

Class VerticalDatumType

Object
CodeList<VerticalDatumType>
VerticalDatumType
All Implemented Interfaces:
Serializable, Comparable<VerticalDatumType>, ControlledVocabulary
@UML(identifier="CD_VerticalDatumType", specification=ISO_19111) public final class VerticalDatumType extends CodeList<VerticalDatumType>
Type of a vertical datum.
Note: 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 never be built as CompoundCRS. If nevertheless an ellipsoidal height is needed (for example in order to process a CRS in the WKT 1 format), implementers can get a suitable vertical datum type using VerticalDatumType.valueOf("ELLIPSOIDAL"). Implementers are encouraged to not expose that datum type in public API however.
Since:
1.0
See Also:
TODO:
This code list was named VerticalDatumType in an OGC specification published in 2003, removed in the ISO 19111:2007 standard, then become RealizationMethod in ISO 19111:2019.

  • Field Details

    • OTHER_SURFACE

      @UML(identifier="other surface", obligation=CONDITIONAL, specification=ISO_19111) public static final VerticalDatumType OTHER_SURFACE
      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
      The zero value of the associated vertical coordinate system axis 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 datum.

    • DEPTH

      @UML(identifier="depth", obligation=CONDITIONAL, specification=ISO_19111) public static final VerticalDatumType DEPTH
      The zero point of the vertical axis 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. Depths are measured in the direction perpendicular (approximately) to the actual equipotential surfaces of the earth's gravity field, using such procedures as echo-sounding.

    • BAROMETRIC

      @UML(identifier="barometric", obligation=CONDITIONAL, specification=ISO_19111) public static final VerticalDatumType BAROMETRIC
      Atmospheric pressure is the basis for the definition of the origin of the associated vertical coordinate system axis. These are approximations of orthometric heights obtained with the help of a barometer or a barometric altimeter. These 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()
      Returns the list of VerticalDatumTypes.
      Returns:
      the list of codes declared in the current JVM.

    • family

      public VerticalDatumType[] family()
      Returns the list of codes of the same kind than 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)
      Returns the vertical datum type that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. 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.