Module org.opengis.geoapi

Package org.opengis.referencing.crs

Interface VerticalCRS

All Superinterfaces:

CoordinateReferenceSystem, IdentifiedObject, ReferenceSystem, SingleCRS

@UML(identifier="VerticalCRS",
     specification=ISO_19111)
public interface VerticalCRS
extends SingleCRS

A 1-dimensional CRS used for recording heights or depths. Vertical CRSs make use of the direction of gravity to define the concept of height or depth, but the relationship with gravity may not be straightforward.

By implication, ellipsoidal heights (h) cannot be captured in a vertical CRS. Ellipsoidal heights cannot exist independently, but only as inseparable part of a 3D coordinate tuple defined in a geographic or projected 3D CRS.

Permitted coordinate systems

This type of CRS can be used with coordinate systems of type VerticalCS only.

Since:

1.0

See Also:

• CRSAuthorityFactory.createVerticalCRS(String)
• CRSFactory.createVerticalCRS(Map, VerticalDatum, DatumEnsemble, VerticalCS)

Field Summary

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, DOMAINS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface org.opengis.referencing.ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Method Summary

Modifier and Type	Method	Description
VerticalCS	getCoordinateSystem()	Returns the coordinate system, which shall be vertical.
VerticalDatum	getDatum()	Returns the reference frame, which shall be vertical.
default DatumEnsemble<VerticalDatum>	getDatumEnsemble()	Returns the datum ensemble, which shall have vertical datum members.

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getDomains, getIdentifiers, getName, getRemarks, toWKT

Methods inherited from interface org.opengis.referencing.ReferenceSystem

getDomainOfValidity, getScope

Method Details

getCoordinateSystem

@UML(identifier="coordinateSystem",
     obligation=MANDATORY,
     specification=ISO_19111)
VerticalCS getCoordinateSystem()

Returns the coordinate system, which shall be vertical.

Specified by:

getCoordinateSystem in interface CoordinateReferenceSystem

Specified by:

getCoordinateSystem in interface SingleCRS

Returns:

the vertical coordinate system.

getDatum

@UML(identifier="datum",
     obligation=CONDITIONAL,
     specification=ISO_19111)
VerticalDatum getDatum()

Returns the reference frame, which shall be vertical. This property may be null if this CRS is related to an object identified only by a datum ensemble.

Specified by:

getDatum in interface SingleCRS

Returns:

the reference frame, or null if this CRS is related to an object identified only by a datum ensemble.

Condition:

Mandatory if the datum ensemble is not documented.

getDatumEnsemble

@UML(identifier="datum",
     obligation=CONDITIONAL,
     specification=ISO_19111)
default DatumEnsemble<VerticalDatum> getDatumEnsemble()

Returns the datum ensemble, which shall have vertical datum members. This property may be null if this CRS is related to an object identified only by a single datum.

The default implementation returns null.

Specified by:

getDatumEnsemble in interface SingleCRS

Returns:

the datum ensemble, or null if this CRS is related to an object identified only by a single datum.

Since:

3.1

Condition:

Mandatory if the datum is not documented.