001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2016-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.ParametricCS;
022import org.opengis.referencing.datum.DatumEnsemble;
023import org.opengis.referencing.datum.ParametricDatum;
024import org.opengis.annotation.UML;
025
026import static org.opengis.annotation.Obligation.*;
027import static org.opengis.annotation.Specification.ISO_19111;
028
029
030/**
031 * A 1-dimensional <abbr>CRS</abbr> which uses parameter values or functions.
032 * A <abbr>CRS</abbr> shall be of the parametric type if a physical or material
033 * property or function is used as the dimension.
034 * The values or functions can vary monotonically with height.
035 *
036 * <div class="note"><b>Examples:</b>
037 * Pressure in meteorological applications, or
038 * density (isopycnals) in oceanographic applications.
039 * </div>
040 *
041 * <h2>Permitted coordinate systems</h2>
042 * This type of <abbr>CRS</abbr> can be used with coordinate systems of type {@link ParametricCS} only.
043 *
044 * @author  OGC Topic 2 (for abstract model and documentation)
045 * @author  Johann Sorel (Geomatys)
046 * @author  Martin Desruisseaux (Geomatys)
047 * @version 3.1
048 * @since   3.1
049 *
050 * @see CRSAuthorityFactory#createParametricCRS(String)
051 * @see CRSFactory#createParametricCRS(Map, ParametricDatum, DatumEnsemble, ParametricCS)
052 */
053@UML(identifier="ParametricCRS", specification=ISO_19111)
054public interface ParametricCRS extends SingleCRS {
055    /**
056     * Returns the coordinate system, which shall be parametric.
057     *
058     * @return the parametric coordinate system.
059     */
060    @Override
061    @UML(identifier="coordinateSystem", obligation=MANDATORY, specification=ISO_19111)
062    ParametricCS getCoordinateSystem();
063
064    /**
065     * Returns the datum, which shall be parametric.
066     * This property may be null if this <abbr>CRS</abbr> is related to an object
067     * identified only by a {@linkplain #getDatumEnsemble() datum ensemble}.
068     *
069     * @return the parametric datum, or {@code null} if this <abbr>CRS</abbr> is related to
070     *         an object identified only by a {@linkplain #getDatumEnsemble() datum ensemble}.
071     *
072     * @condition Mandatory if the {@linkplain #getDatumEnsemble() datum ensemble} is not documented.
073     */
074    @Override
075    @UML(identifier="datum", obligation=CONDITIONAL, specification=ISO_19111)
076    ParametricDatum getDatum();
077
078    /**
079     * Returns the datum ensemble, which shall have parametric datum members.
080     * This property may be null if this <abbr>CRS</abbr> is related to an object
081     * identified only by a single {@linkplain #getDatum() datum}.
082     *
083     * <p>The default implementation returns {@code null}.</p>
084     *
085     * @return the datum ensemble, or {@code null} if this <abbr>CRS</abbr> is related
086     *         to an object identified only by a single {@linkplain #getDatum() datum}.
087     *
088     * @condition Mandatory if the {@linkplain #getDatum() datum} is not documented.
089     */
090    @Override
091    @UML(identifier="datum", obligation=CONDITIONAL, specification=ISO_19111)
092    default DatumEnsemble<ParametricDatum> getDatumEnsemble() {
093        return null;
094    }
095}