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.operation;
019
020import java.util.Optional;
021import java.time.temporal.Temporal;
022import org.opengis.referencing.crs.CoordinateReferenceSystem;
023import org.opengis.annotation.UML;
024
025import static org.opengis.annotation.Obligation.*;
026import static org.opengis.annotation.Specification.*;
027
028
029/**
030 * Change of coordinate values within one <abbr>CRS</abbr> due to the motion of the point between two coordinate epochs.
031 * The motion is typically due to tectonic plate movement or deformation.
032 *
033 * @author  OGC Topic 2 (for abstract model and documentation)
034 * @author  Martin Desruisseaux (IRD, Geomatys)
035 * @version 3.1
036 * @since   3.1
037 */
038@UML(identifier="PointMotionOperation", specification=ISO_19111)
039public interface PointMotionOperation extends SingleOperation {
040    /**
041     * Returns the <abbr>CRS</abbr> from which coordinates are changed.
042     * This attribute is mandatory in all point motion operations.
043     * It shall be the same as the {@linkplain #getTargetCRS() target <abbr>CRS</abbr>}.
044     *
045     * @return the <abbr>CRS</abbr> from which coordinates are changed. Shall not be {@code null}.
046     */
047    @Override
048    @UML(identifier="sourceCRS", obligation=MANDATORY, specification=ISO_19111)
049    CoordinateReferenceSystem getSourceCRS();
050
051    /**
052     * Returns the <abbr>CRS</abbr> to which coordinates are changed.
053     * This attribute is mandatory in all point motion operations.
054     * It shall be the same as the {@linkplain #getSourceCRS() source <abbr>CRS</abbr>}.
055     *
056     * <p>The default implementation returns {@link #getSourceCRS()}.</p>
057     *
058     * @return the <abbr>CRS</abbr> to which coordinates are changed. Shall not be {@code null}.
059     */
060    @Override
061    @UML(identifier="targetCRS", obligation=MANDATORY, specification=ISO_19111)
062    default CoordinateReferenceSystem getTargetCRS() {
063        return getSourceCRS();
064    }
065
066    /**
067     * Returns the date at which source coordinate tuples are valid.
068     * This is mandatory for point motion operations.
069     *
070     * @return epoch at which source coordinate tuples are valid. Shall not be empty.
071     */
072    @Override
073    @UML(identifier="sourceCoordinateEpoch", obligation=MANDATORY, specification=ISO_19111)
074    Optional<Temporal> getSourceEpoch();
075
076    /**
077     * Returns the date at which target coordinate tuples are valid.
078     * This is mandatory for point motion operations.
079     *
080     * @return epoch at which target coordinate tuples are valid. Shall not be empty.
081     */
082    @Override
083    @UML(identifier="targetCoordinateEpoch", obligation=MANDATORY, specification=ISO_19111)
084    Optional<Temporal> getTargetEpoch();
085
086    /**
087     * Returns the version of this point motion operation.
088     * The version is an identification of the instantiation due to the stochastic nature of the parameters.
089     * This attribute is mandatory in all point motion operations.
090     *
091     * @return version of the point motion operation. Shall not be null.
092     */
093    @Override
094    @UML(identifier="operationVersion", obligation=MANDATORY, specification=ISO_19111)
095    String getOperationVersion();
096}