001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.referencing.crs;
033    
034    import java.util.Map;
035    import org.opengis.referencing.cs.CoordinateSystem;
036    import org.opengis.referencing.datum.EngineeringDatum;
037    import org.opengis.annotation.UML;
038    
039    import static org.opengis.annotation.Obligation.*;
040    import static org.opengis.annotation.Specification.*;
041    
042    
043    /**
044     * A contextually local coordinate reference system. It can be divided into two broad categories:
045     * <p>
046     * <ul>
047     *   <li>earth-fixed systems applied to engineering activities on or near the surface of the
048     *       earth;</li>
049     *   <li>CRSs on moving platforms such as road vehicles, vessels, aircraft, or spacecraft.</li>
050     * </ul>
051     * <p>
052     * Earth-fixed Engineering CRSs are commonly based on a simple flat-earth approximation of the
053     * earth's surface, and the effect of earth curvature on feature geometry is ignored: calculations
054     * on coordinates use simple plane arithmetic without any corrections for earth curvature. The
055     * application of such Engineering CRSs to relatively small areas and "contextually local" is in
056     * this case equivalent to "spatially local".
057     * <p>
058     * Engineering CRSs used on moving platforms are usually intermediate coordinate reference
059     * systems that are computationally required to calculate coordinates referenced to
060     * {@linkplain GeocentricCRS geocentric}, {@linkplain GeographicCRS geographic} or
061     * {@linkplain ProjectedCRS projected} CRSs. These engineering coordinate reference
062     * systems are subject to all the motions of the platform with which they are associated.
063     * In this case "contextually local" means that the associated coordinates are meaningful
064     * only relative to the moving platform. Earth curvature is usually irrelevant and is therefore
065     * ignored. In the spatial sense their applicability may extend from the immediate vicinity of
066     * the platform (e.g. a moving seismic ship) to the entire earth (e.g. in space applications).
067     * The determining factor is the mathematical model deployed in the positioning calculations.
068     * Transformation of coordinates from these moving Engineering CRSs to earth-referenced coordinate
069     * reference systems involves time-dependent coordinate operation parameters.
070     *
071     * <TABLE CELLPADDING='6' BORDER='1'>
072     * <TR BGCOLOR="#EEEEFF"><TH NOWRAP>Used with CS type(s)</TH></TR>
073     * <TR><TD>
074     *   {@link org.opengis.referencing.cs.AffineCS           Affine},
075     *   {@link org.opengis.referencing.cs.CartesianCS        Cartesian},
076     *   {@link org.opengis.referencing.cs.EllipsoidalCS      Ellipsoidal},
077     *   {@link org.opengis.referencing.cs.SphericalCS        Spherical},
078     *   {@link org.opengis.referencing.cs.CylindricalCS      Cylindrical},
079     *   {@link org.opengis.referencing.cs.PolarCS            Polar},
080     *   {@link org.opengis.referencing.cs.VerticalCS         Vertical},
081     *   {@link org.opengis.referencing.cs.LinearCS           Linear}
082     * </TD></TR></TABLE>
083     *
084     * @author  Martin Desruisseaux (IRD)
085     * @version 3.0
086     * @since   1.0
087     *
088     * @navassoc 1 - - EngineeringDatum
089     * @navassoc 1 - - CoordinateSystem
090     *
091     * @see CRSAuthorityFactory#createEngineeringCRS(String)
092     * @see CRSFactory#createEngineeringCRS(Map, EngineeringDatum, CoordinateSystem)
093     */
094    @UML(identifier="SC_EngineeringCRS", specification=ISO_19111)
095    public interface EngineeringCRS extends SingleCRS {
096        /**
097         * Returns the datum, which must be an engineering one.
098         */
099        @Override
100        @UML(identifier="datum", obligation=MANDATORY, specification=ISO_19111)
101        EngineeringDatum getDatum();
102    }