Application: gvSIG desktop » gvSIG projections

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2018 gvSIG Association.

 * 

 * This file has been adapted from GeoAPI, see 

 * the original copyright headers bellow.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 * 

 * ----------

 * 

 *    GeoAPI - Java interfaces for OGC/ISO standards

 *    http://www.geoapi.org

 *

 *    Copyright (C) 2004-2017 Open Geospatial Consortium, Inc.

 *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal

 *

 *    Permission to use, copy, and modify this software and its documentation, with

 *    or without modification, for any purpose and without fee or royalty is hereby

 *    granted, provided that you include the following on ALL copies of the software

 *    and documentation or portions thereof, including modifications, that you make:

 *

 *    1. The full text of this NOTICE in a location viewable to users of the

 *       redistributed or derivative work.

 *    2. Notice of any changes or modifications to the OGC files, including the

 *       date changes were made.

 *

 *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE

 *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED

 *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT

 *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY

 *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

 *

 *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR

 *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.

 *

 *    The name and trademarks of copyright holders may NOT be used in advertising or

 *    publicity pertaining to the software without specific, written prior permission.

 *    Title to copyright in this software and any associated documentation will at all

 *    times remain with copyright holders.

 */

 package org.gvsig.proj.catalogue.datum;

/**

 * A textual description and/or a set of parameters identifying a particular reference level

 * surface used as a zero-height surface. The description includes its position with respect

 * to the Earth for any of the height types recognized by this standard.

 *

 * <p>There are several types of Vertical Datums, and each may place constraints on the

 * {@linkplain org.opengis.referencing.cs.CoordinateSystemAxis Coordinate Axis} with which

 * it is combined to create a {@linkplain org.opengis.referencing.crs.VerticalCRS Vertical CRS}.</p>

 *

 * Note: gvSIG derived these interfaces from GeoAPI in order to have a simpler API and also to

 * avoid namespace collisions (e.g. GeoAPI 3 vs GeoTools interfaces). There is no plans

 * to evolve these interfaces to adapt them to future GeoAPI versions.

 * 

 * @author  gvSIG Team

 * @author  Martin Desruisseaux (IRD)

 * @version 3.0

 * @since   1.0

 *

 * @see DatumAuthorityFactory#createVerticalDatum(String)

 * @see DatumFactory#createVerticalDatum(Map, VerticalDatumType)

 */

public interface VerticalDatum extends Datum {

    /**

     * The type of this vertical datum.

     *

     * @departure historic

     *   This attribute is kept conformant with the specification published in 2003.

     *   The 2007 revision of ISO 19111 removed this attribute, since this information

     *   can be encoded in the <cite>anchor definition</cite>. However GeoAPI keep this attribute

     *   for historical reasons, and because it provides some of the anchor definition information

     *   in a programmatic way more suitable to coordinate transformation engines.

     *

     * @return the type of this vertical datum.

     *

     * @see #getAnchorPoint()

     */

        VerticalDatumType getVerticalDatumType();

}