001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006 * All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007 *
008 * Permission to use, copy, and modify this software and its documentation, with
009 * or without modification, for any purpose and without fee or royalty is hereby
010 * granted, provided that you include the following on ALL copies of the software
011 * and documentation or portions thereof, including modifications, that you make:
012 *
013 * 1. The full text of this NOTICE in a location viewable to users of the
014 * redistributed or derivative work.
015 * 2. Notice of any changes or modifications to the OGC files, including the
016 * date changes were made.
017 *
018 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019 * NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020 * TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021 * THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022 * PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023 *
024 * COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025 * CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026 *
027 * The name and trademarks of copyright holders may NOT be used in advertising or
028 * publicity pertaining to the software without specific, written prior permission.
029 * Title to copyright in this software and any associated documentation will at all
030 * times remain with copyright holders.
031 */
032 package org.opengis.referencing.datum;
033
034 import java.util.Map;
035 import org.opengis.annotation.UML;
036
037 import static org.opengis.annotation.Obligation.*;
038 import static org.opengis.annotation.Specification.*;
039
040
041 /**
042 * A textual description and/or a set of parameters identifying a particular reference level
043 * surface used as a zero-height surface. The description includes its position with respect
044 * to the Earth for any of the height types recognized by this standard.
045 * <p>
046 * There are several types of Vertical Datums, and each may place constraints on the
047 * {@linkplain org.opengis.referencing.cs.CoordinateSystemAxis Coordinate Axis} with which
048 * it is combined to create a {@linkplain org.opengis.referencing.crs.VerticalCRS Vertical CRS}.
049 *
050 * @author Martin Desruisseaux (IRD)
051 * @version 3.0
052 * @since 1.0
053 *
054 * @navassoc 1 - - VerticalDatumType
055 *
056 * @see DatumAuthorityFactory#createVerticalDatum(String)
057 * @see DatumFactory#createVerticalDatum(Map, VerticalDatumType)
058 */
059 @UML(identifier="CD_VerticalDatum", specification=ISO_19111)
060 public interface VerticalDatum extends Datum {
061 /**
062 * The type of this vertical datum.
063 *
064 * @departure historic
065 * This attribute is kept conformant with the specification published in 2003.
066 * The 2007 revision of ISO 19111 removed this attribute, since this information
067 * can be encoded in the <cite>anchor point</cite>. However GeoAPI keep this attribute
068 * for historical reasons, and because it provides some of the anchor point information
069 * in a programmatic way more suitable to coordinate transformation engines.
070 * <p>
071 * Note that GML defines the anchor point as a code list, which address the programmatic
072 * needs. In GeoAPI the anchor point is rather defined as an international string, thus
073 * the need for equivalent information as a code list.
074 *
075 * @return The type of this vertical datum.
076 *
077 * @see #getAnchorPoint()
078 */
079 @UML(identifier="vertDatumType", obligation=MANDATORY, specification=ISO_19111)
080 VerticalDatumType getVerticalDatumType();
081 }