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.crs;
019
020import java.util.Map;
021import org.opengis.referencing.cs.CartesianCS;
022import org.opengis.referencing.cs.SphericalCS;
023import org.opengis.referencing.cs.CoordinateSystem;
024import org.opengis.referencing.datum.GeodeticDatum;
025import org.opengis.annotation.UML;
026
027import static org.opengis.annotation.Obligation.*;
028import static org.opengis.annotation.Specification.*;
029
030
031/**
032 * A 3-dimensional <abbr>CRS</abbr> with the origin at the approximate centre of mass of the planet.
033 * A geocentric CRS deals with the planet's curvature by taking a 3-dimensional spatial view, which
034 * obviates the need to model the planet's curvature.
035 *
036 * <h2>Permitted coordinate systems</h2>
037 * This type of <abbr>CRS</abbr> can be used with coordinate systems of type
038 * {@link org.opengis.referencing.cs.CartesianCS Cartesian} or
039 * {@link org.opengis.referencing.cs.SphericalCS Spherical}.
040 *
041 * @author  OGC Topic 2 (for abstract model and documentation)
042 * @author  Martin Desruisseaux (IRD, Geomatys)
043 * @version 3.1
044 * @since   1.0
045 *
046 * @see CRSAuthorityFactory#createGeocentricCRS(String)
047 * @see CRSFactory#createGeocentricCRS(Map, GeodeticDatum, CartesianCS)
048 * @see CRSFactory#createGeographicCRS(Map, GeodeticDatum, EllipsoidalCS)
049 *
050 * @deprecated This type was defined in 2003 but removed in 2007.
051 * The ISO 19111 revision published in 2019 still excludes this type.
052 * The {@link GeodeticCRS} base type should be used instead.
053 */
054@Deprecated(since="3.1")
055@UML(identifier="SC_GeocentricCRS", specification=ISO_19111, version=2003)
056public interface GeocentricCRS extends GeodeticCRS {
057    /**
058     * Returns the coordinate system, which shall be {@linkplain CartesianCS Cartesian}
059     * or {@linkplain SphericalCS spherical}.
060     *
061     * @return the Cartesian or spherical coordinate system.
062     */
063    @Override
064    @UML(identifier="coordinateSystem", obligation=MANDATORY, specification=ISO_19111)
065    CoordinateSystem getCoordinateSystem();
066}