Module org.opengis.geoapi

Package org.opengis.referencing.datum

Interface VerticalDatum

All Superinterfaces:

Datum, IdentifiedObject

@UML(identifier="VerticalReferenceFrame",
     specification=ISO_19111)
public interface VerticalDatum
extends Datum

Identification of a particular reference level surface used as a zero-height surface. The description includes its position with respect to the planet for any of the height types recognized by the ISO 19111 standard.

There are several types of vertical reference frames, and each may place constraints on the Coordinate Axis with which it is combined to create a Vertical CRS.

Since:

1.0

See Also:

• DatumAuthorityFactory.createVerticalDatum(String)
• DatumFactory.createVerticalDatum(Map, RealizationMethod)

Field Summary

Fields inherited from interface org.opengis.referencing.datum.Datum

ANCHOR_DEFINITION_KEY, ANCHOR_EPOCH_KEY, ANCHOR_POINT_KEY, CONVENTIONAL_RS_KEY, DOMAIN_OF_VALIDITY_KEY, PUBLICATION_DATE_KEY, REALIZATION_EPOCH_KEY, SCOPE_KEY

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, DOMAINS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
default Optional<RealizationMethod>	getRealizationMethod()	Returns the method through which this vertical reference frame is realized.
default VerticalDatumType	getVerticalDatumType()	Deprecated. Replaced by getRealizationMethod() in ISO 19111:2019.

Methods inherited from interface org.opengis.referencing.datum.Datum

getAnchorDefinition, getAnchorEpoch, getAnchorPoint, getConventionalRS, getDomainOfValidity, getPublicationDate, getRealizationEpoch, getScope

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getDomains, getIdentifiers, getName, getRemarks, toWKT

Method Details

getRealizationMethod

@UML(identifier="realizationMethod",
     obligation=OPTIONAL,
     specification=ISO_19111)
default Optional<RealizationMethod> getRealizationMethod()

Returns the method through which this vertical reference frame is realized.

Returns:

method through which this vertical reference frame is realized.

Since:

3.1

getVerticalDatumType

@Deprecated(since="3.1")
@UML(identifier="vertDatumType",
     obligation=MANDATORY,
     specification=ISO_19111,
     version=2003)
default VerticalDatumType getVerticalDatumType()

Deprecated.

Replaced by getRealizationMethod() in ISO 19111:2019.

The type of this vertical datum.

Returns:

the type of this vertical datum.