001/*
002 *    GeoAPI - Java interfaces for OGC/ISO standards
003 *    Copyright © 2003-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.cs;
019
020import java.util.Map;
021import org.opengis.annotation.UML;
022import static org.opengis.annotation.Specification.*;
023
024
025/**
026 * A 3-dimensional cylindrical coordinate system.
027 * It consists of a {@link PolarCS} extended by a straight axis perpendicular to the plane spanned by the polar CS.
028 *
029 * <p>This type of <abbr>CS</abbr> can be used by coordinate reference systems of type
030 * {@link org.opengis.referencing.crs.EngineeringCRS}, potentially in combination with
031 * {@link org.opengis.referencing.crs.DerivedCRS}.</p>
032 *
033 * @author  OGC Topic 2 (for abstract model and documentation)
034 * @author  Martin Desruisseaux (IRD, Geomatys)
035 * @version 3.1
036 * @since   1.0
037 *
038 * @see PolarCS
039 * @see CSAuthorityFactory#createCylindricalCS(String)
040 * @see CSFactory#createCylindricalCS(Map, CoordinateSystemAxis, CoordinateSystemAxis, CoordinateSystemAxis)
041 */
042@UML(identifier="CylindricalCS", specification=ISO_19111)
043public interface CylindricalCS extends CoordinateSystem {
044    /**
045     * Returns the number of dimensions, which is 3 for this type of coordinate system.
046     *
047     * @return always 3.
048     */
049    @Override
050    default int getDimension() {
051        return 3;
052    }
053}