001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2003-2024 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 org.opengis.referencing.operation.Conversion;
021import org.opengis.annotation.UML;
022import org.opengis.annotation.Classifier;
023import org.opengis.annotation.Stereotype;
024
025import static org.opengis.annotation.Obligation.*;
026import static org.opengis.annotation.Specification.*;
027
028
029/**
030 * A <abbr>CRS</abbr> that is defined by applying a coordinate conversion to another preexisting <abbr>CRS</abbr>.
031 * The derived <abbr>CRS</abbr> inherits its datum (reference frame) or datum ensemble from its base <abbr>CRS</abbr>.
032 *
033 * @author  Martin Desruisseaux (IRD, Geomatys)
034 * @version 3.1
035 * @since   1.0
036 *
037 * @deprecated As of ISO 19111:2019, this interface is renamed as {@link DerivedCRS}.
038 */
039@Deprecated(since="3.1")
040@Classifier(Stereotype.ABSTRACT)
041@UML(identifier="SC_GeneralDerivedCRS", specification=ISO_19111, version=2007)
042public interface GeneralDerivedCRS extends SingleCRS {
043    /**
044     * Returns the base coordinate reference system.
045     *
046     * <div class="warning"><b>Upcoming API change — specialization</b><br>
047     * According ISO 19111, the return type should be {@link SingleCRS}.
048     * This change may be applied in GeoAPI 4.0.
049     * </div>
050     *
051     * @return the base coordinate reference system.
052     */
053    @UML(identifier="baseCRS", obligation=MANDATORY, specification=ISO_19111, version=2007)
054    CoordinateReferenceSystem getBaseCRS();
055
056    /**
057     * Returns the conversion from the {@linkplain #getBaseCRS() base CRS} to this CRS.
058     *
059     * @return the conversion from the base CRS.
060     */
061    @UML(identifier="conversion", obligation=MANDATORY, specification=ISO_19111, version=2007)
062    Conversion getConversionFromBase();
063}