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;

import javax.measure.Unit;

/**

 * Definition of a coordinate system axis

 * 

 * @author  Martin Desruisseaux (IRD)

 * @author Cesar Martinez Izquierdo

 *

 */

public interface CoordinateSystemAxis {

    /**

     * The name of this coordinate system axis.

     * 

     * @return the name

     */

        String getName();

        /**

         * The abbreviation used for this coordinate system axis.

         * 

         * @return the abbreviation

         */

    String getAbbreviation();

    /**

     * Returns the direction of this coordinate system axis. In the case of Cartesian projected

     * coordinates, this is the direction of this coordinate system axis locally.

     * Examples:

     * {@linkplain AxisDirection#NORTH north} or {@linkplain AxisDirection#SOUTH south},

     * {@linkplain AxisDirection#EAST  east}  or {@linkplain AxisDirection#WEST  west},

     * {@linkplain AxisDirection#UP    up}    or {@linkplain AxisDirection#DOWN  down}.

     *

     * <p>Within any set of coordinate system axes, only one of each pair of terms can be used.

     * For earth-fixed coordinate reference systems, this direction is often approximate

     * and intended to provide a human interpretable meaning to the axis.

     * When a geodetic datum is used, the precise directions of the axes may therefore

     * vary slightly from this approximate direction.</p>

     *

     * <p>Note that an {@link org.opengis.referencing.crs.EngineeringCRS} often requires

     * specific descriptions of the directions of its coordinate system axes.</p>

     *

     * @return the coordinate system axis direction.

     */

    AxisDirection getDirection();

    /**

     * Returns the unit of measure used for this coordinate system axis.

     * The value of a ordinate in a coordinate tuple shall be recorded using this unit of measure,

     * whenever those coordinates use a coordinate reference system that uses a coordinate system

     * that uses this axis.

     *

     * @return the coordinate system axis unit.

     */

    Unit<?> getUnit();

}