Package org.opengis.referencing.datum
Class VerticalDatumType
- java.lang.Object
-
- org.opengis.util.CodeList<VerticalDatumType>
-
- org.opengis.referencing.datum.VerticalDatumType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<VerticalDatumType>
@UML(identifier="CD_VerticalDatumType", specification=ISO_19111) public final class VerticalDatumType extends CodeList<VerticalDatumType>
Type of a vertical datum.- Since:
- 1.0
- Version:
- 3.0
- See Also:
- 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 VerticalDatumType
BAROMETRIC
Atmospheric pressure is the basis for the definition of the origin of the associated vertical coordinate system axis.static 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.static VerticalDatumType
GEOIDAL
The zero value of the associated vertical coordinate system axis is defined to approximate a constant potential surface, usually the geoid.static VerticalDatumType
OTHER_SURFACE
In some cases, e.g.private static long
serialVersionUID
Serial number for compatibility with different versions.private static java.util.List<VerticalDatumType>
VALUES
List of all enumerations of this type.
-
Constructor Summary
Constructors Modifier Constructor Description private
VerticalDatumType(java.lang.String name)
Constructs an enum with the given name.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description VerticalDatumType[]
family()
Returns the list of enumerations of the same kind than this enum.static VerticalDatumType
valueOf(java.lang.String code)
Returns the vertical datum type that matches the given string, or returns a new one if none match it.static VerticalDatumType[]
values()
Returns the list ofVerticalDatumType
s.
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serial number for compatibility with different versions.- See Also:
- Constant Field Values
-
VALUES
private static final java.util.List<VerticalDatumType> VALUES
List of all enumerations of this type. Must be declared before any enum declaration.
-
OTHER_SURFACE
@UML(identifier="other surface", obligation=CONDITIONAL, specification=ISO_19111) public static final VerticalDatumType OTHER_SURFACE
In some cases, e.g. 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).
-
-
Constructor Detail
-
VerticalDatumType
private VerticalDatumType(java.lang.String name)
Constructs an enum with the given name. The new enum is automatically added to the list returned byvalues()
.- Parameters:
name
- The enum name. This name must not be in use by an other enum of this type.
-
-
Method Detail
-
values
public static VerticalDatumType[] values()
Returns the list ofVerticalDatumType
s.- Returns:
- The list of codes declared in the current JVM.
-
family
public VerticalDatumType[] family()
Returns the list of enumerations of the same kind than this enum.- Specified by:
family
in classCodeList<VerticalDatumType>
- Returns:
- The codes of the same kind than this code.
-
valueOf
public static VerticalDatumType valueOf(java.lang.String code)
Returns the vertical datum type that matches the given string, or returns a new one if none match it.- Parameters:
code
- The name of the code to fetch or to create.- Returns:
- A code matching the given name.
-
-