org.opengis.referencing.crs.VerticalCRS Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gt-opengis Show documentation

Standard interfaces implemented throughout the library.

There is a newer version: 24.2-oss84-1

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2003-2005, Open Geospatial Consortium Inc.
 *
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.referencing.crs;

import static org.opengis.annotation.Obligation.*;
import static org.opengis.annotation.Specification.*;

import org.opengis.annotation.UML;
import org.opengis.referencing.cs.VerticalCS;
import org.opengis.referencing.datum.VerticalDatum;

/**
 * A 1D coordinate reference system 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 coordinate
 * reference system. Ellipsoidal heights cannot exist independently, but only as inseparable part of
 * a 3D coordinate tuple defined in a geographic 3D coordinate reference system. However GeoAPI does
 * not enforce this rule. Some applications may relax this rule and accept ellipsoidal heights in
 * the following context:
 *
 * 

 *   
 *       As a transient state while parsing Well Known Text,
 *       or any other format based on legacy specifications where ellipsoidal heights were allowed
 *       as an independant axis.
 *   

 *       As short-lived objects to be passed or returned by methods enforcing type safety, for
 *       example {@link org.opengis.metadata.extent.VerticalExtent#getVerticalCRS}.
 *   

 *       Other cases at implementor convenience. However implementors are encouraged to assemble
 *       the full 3D CRS as soon as they can.
 * 
 *
 * 
 * 
 * Used with CS type(s)

 *   {@link org.opengis.referencing.cs.VerticalCS Vertical}
 * 
 *
 * @version Abstract
 *     specification 2.0
 * @author Martin Desruisseaux (IRD)
 * @since GeoAPI 1.0
 */
@UML(identifier = "SC_VerticalCRS", specification = ISO_19111)
public interface VerticalCRS extends SingleCRS {
    /** Returns the coordinate system, which must be vertical. */
    @UML(identifier = "usesCS", obligation = MANDATORY, specification = ISO_19111)
    VerticalCS getCoordinateSystem();

    /** Returns the datum, which must be vertical. */
    @UML(identifier = "usesDatum", obligation = MANDATORY, specification = ISO_19111)
    VerticalDatum getDatum();
}