001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2003-2023 Open Geospatial Consortium, Inc.
004 *    http://www.geoapi.org
005 *
006 *    Licensed under the Apache License, Version 2.0 (the "License");
007 *    you may not use this file except in compliance with the License.
008 *    You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *    Unless required by applicable law or agreed to in writing, software
013 *    distributed under the License is distributed on an "AS IS" BASIS,
014 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 *    See the License for the specific language governing permissions and
016 *    limitations under the License.
017 */
018package org.opengis.referencing.cs;
019
020import java.util.Map;
021import org.opengis.annotation.UML;
022import static org.opengis.annotation.Specification.*;
023
024
025/**
026 * A 2- or 3-dimensional coordinate system in Euclidean space with orthogonal straight axes.
027 * All axes shall have the same length unit of measure.
028 *
029 * <p>This type of <abbr>CS</abbr> can be used by coordinate reference systems of type
030 * {@link org.opengis.referencing.crs.GeodeticCRS},
031 * {@link org.opengis.referencing.crs.ProjectedCRS} or
032 * {@link org.opengis.referencing.crs.EngineeringCRS}, potentially in combination with
033 * {@link org.opengis.referencing.crs.DerivedCRS}.
034 * The following examples describe some possible set of axes for Cartesian CS used with the above-cited CRS:</p>
035 *
036 * <table class="ogc">
037 *   <caption>Example 1: used with a Projected CRS</caption>
038 *   <tr><th>Axis name</th> <th>Abbr.</th> <th>Direction</th> <th>Unit</th></tr>
039 *   <tr><td>Easting</td> <td>E</td> <td>{@link AxisDirection#EAST}</td>  <td>metre</td></tr>
040 *   <tr><td>Northing</td><td>N</td> <td>{@link AxisDirection#NORTH}</td> <td>metre</td></tr>
041 * </table>
042 *
043 * <table class="ogc">
044 *   <caption>Example 2: used with a Geocentric CRS</caption>
045 *   <tr><th>Axis name</th> <th>Abbr.</th> <th>Direction</th> <th>Unit</th></tr>
046 *   <tr><td>Geocentric X</td><td>X</td> <td>{@link AxisDirection#GEOCENTRIC_X}</td> <td>metre</td></tr>
047 *   <tr><td>Geocentric Y</td><td>Y</td> <td>{@link AxisDirection#GEOCENTRIC_Y}</td> <td>metre</td></tr>
048 *   <tr><td>Geocentric Z</td><td>Z</td> <td>{@link AxisDirection#GEOCENTRIC_Z}</td> <td>metre</td></tr>
049 * </table>
050 *
051 * <table class="ogc">
052 *   <caption>Example 3: used with an Engineering CRS for a station fixed to Earth</caption>
053 *   <tr><th>Axis name</th> <th>Abbr.</th> <th>Direction</th> <th>Unit</th></tr>
054 *   <tr><td>Site north</td><td>x</td> <td>{@link AxisDirection#SOUTH_EAST}</td> <td>metre</td></tr>
055 *   <tr><td>Site east</td> <td>y</td> <td>{@link AxisDirection#SOUTH_WEST}</td> <td>metre</td></tr>
056 * </table>
057 *
058 * <table class="ogc">
059 *   <caption>Example 4: used with an Engineering CRS for a moving platform</caption>
060 *   <tr><th>Axis name</th> <th>Abbr.</th> <th>Direction</th> <th>Unit</th></tr>
061 *   <tr><td>Ahead</td><td>x</td> <td>{@link AxisDirection#FORWARD}</td>   <td>metre</td></tr>
062 *   <tr><td>Right</td><td>y</td> <td>{@link AxisDirection#STARBOARD}</td> <td>metre</td></tr>
063 *   <tr><td>Down</td> <td>z</td> <td>{@link AxisDirection#DOWN}</td>      <td>metre</td></tr>
064 * </table>
065 *
066 * @author  OGC Topic 2 (for abstract model and documentation)
067 * @author  Martin Desruisseaux (IRD, Geomatys)
068 * @version 3.1
069 * @since   1.0
070 *
071 * @see CSAuthorityFactory#createCartesianCS(String)
072 * @see CSFactory#createCartesianCS(Map, CoordinateSystemAxis, CoordinateSystemAxis)
073 * @see CSFactory#createCartesianCS(Map, CoordinateSystemAxis, CoordinateSystemAxis, CoordinateSystemAxis)
074 */
075@UML(identifier="CartesianCS", specification=ISO_19111)
076public interface CartesianCS extends AffineCS {
077}