001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2004-2013 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.cs;
033
034 import org.opengis.referencing.IdentifiedObject;
035 import org.opengis.annotation.UML;
036 import org.opengis.annotation.Classifier;
037 import org.opengis.annotation.Stereotype;
038
039 import static org.opengis.annotation.Obligation.*;
040 import static org.opengis.annotation.Specification.*;
041
042
043 /**
044 * The set of coordinate system axes that spans a given coordinate space. A coordinate system (CS)
045 * is derived from a set of (mathematical) rules for specifying how coordinates in a given space
046 * are to be assigned to points. The coordinate values in a coordinate tuple shall be recorded in
047 * the order in which the coordinate system axes associations are recorded, whenever those
048 * coordinates use a coordinate reference system that uses this coordinate system.
049 *
050 * @author Martin Desruisseaux (IRD)
051 * @version 3.1
052 * @since 1.0
053 *
054 * @see org.opengis.referencing.cs.CoordinateSystemAxis
055 * @see javax.measure.unit.Unit
056 * @see org.opengis.referencing.datum.Datum
057 * @see org.opengis.referencing.crs.CoordinateReferenceSystem
058 *
059 * @navassoc - - - CoordinateSystemAxis
060 */
061 @Classifier(Stereotype.ABSTRACT)
062 @UML(identifier="CS_CoordinateSystem", specification=ISO_19111)
063 public interface CoordinateSystem extends IdentifiedObject {
064 /**
065 * Returns the dimension of the coordinate system.
066 *
067 * @return The dimension of the coordinate system.
068 */
069 int getDimension();
070
071 /**
072 * Returns the axis for this coordinate system at the specified dimension.
073 * Each coordinate system must have at least one axis.
074 *
075 * @param dimension The zero based index of axis.
076 * @return The axis at the specified dimension.
077 * @throws IndexOutOfBoundsException if {@code dimension} is out of bounds.
078 */
079 @UML(identifier="axis", obligation=MANDATORY, specification=ISO_19111)
080 CoordinateSystemAxis getAxis(int dimension) throws IndexOutOfBoundsException;
081 }