Package org.opengis.referencing.cs

Interface CoordinateSystemAxis

  • All Superinterfaces:
    org.opengis.referencing.IdentifiedObject
    public interface CoordinateSystemAxis
extends org.opengis.referencing.IdentifiedObject
    Definition of a coordinate system axis. See axis name constraints.
    Since:
    GeoAPI 1.0
    See Also:
    CoordinateSystem, Unit

    • Field Summary

      • Fields inherited from interface org.opengis.referencing.IdentifiedObject

        ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAbbreviation()
      The abbreviation used for this coordinate system axes.
      org.opengis.referencing.cs.AxisDirection getDirection()
      Direction of this coordinate system axis.
      Unit<?> getUnit()
      The unit of measure used for this coordinate system axis.

      • Methods inherited from interface org.opengis.referencing.IdentifiedObject

        getAlias, getIdentifiers, getName, getRemarks, toWKT

    • Method Detail

      • getAbbreviation

        String getAbbreviation()
        The abbreviation used for this coordinate system axes. This abbreviation is also used to identify the ordinates in coordinate tuple. Examples are "X" and "Y".
        Returns:
        The coordinate system axis abbreviation.

      • getDirection

        org.opengis.referencing.cs.AxisDirection getDirection()
        Direction of this coordinate system axis. In the case of Cartesian projected coordinates, this is the direction of this coordinate system axis locally. Examples: north or south, east or west, up or down. Within any set of coordinate system axes, only one of each pair of terms can be used. For earth-fixed coordinate reference systems, this direction is often approximate and intended to provide a human interpretable meaning to the axis. When a geodetic datum is used, the precise directions of the axes may therefore vary slightly from this approximate direction. Note that an org.opengis.referencing.crs.EngineeringCRS often requires specific descriptions of the directions of its coordinate system axes.
        Returns:
        The coordinate system axis direction.

      • getUnit

        Unit<?> getUnit()
        The unit of measure used for this coordinate system axis. The value of this coordinate in a coordinate tuple shall be recorded using this unit of measure, whenever those coordinates use a coordinate reference system that uses a coordinate system that uses this axis.
        Returns:
        The coordinate system axis unit.