Package org.opengis.referencing.cs
Interface CoordinateSystemAxis
-
- All Superinterfaces:
IdentifiedObject
@UML(identifier="CS_CoordinateSystemAxis", specification=ISO_19111) public interface CoordinateSystemAxis extends IdentifiedObject
Definition of a coordinate system axis.Axis name
Usage of coordinate system axis names is constrained by geodetic custom in a number of cases, depending mainly on the coordinate reference system type. These constraints are shown in the table below. This constraint works in two directions; for example the names "geodetic latitude" and "geodetic longitude" shall be used to designate the coordinate axis names associated with a geographic coordinate reference system. Conversely, these names shall not be used in any other context.Context of coordinate system axis names usage CS CRS Permitted coordinate system axis names Cartesian Geocentric Geocentric X, Geocentric Y, Geocentric Z Spherical Geocentric Spherical Latitude, Spherical Longitude, Geocentric Radius Ellipsoidal Geographic Geodetic Latitude, Geodetic Longitude, Ellipsoidal height (if 3D) Vertical Vertical Gravity-related height or Depth Cartesian Projected Easting or Westing, Northing or Southing Axis direction
The direction of the coordinate axes is often only approximate; two geographic coordinate reference systems will make use of the same ellipsoidal coordinate system. These coordinate systems are associated with the earth through two different geodetic datums, which may lead to the two systems being slightly rotated with respect to each other.
-
-
Field Summary
-
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
-
-
Method Summary
Modifier and Type Method Description String
getAbbreviation()
Returns the abbreviation used for this coordinate system axes.AxisDirection
getDirection()
Returns the direction of this coordinate system axis.default double
getMaximumValue()
Returns the maximum value normally allowed for this axis, in the unit of measure for the axis.default double
getMinimumValue()
Returns the minimum value normally allowed for this axis, in the unit of measure for the axis.default RangeMeaning
getRangeMeaning()
Unit<?>
getUnit()
Returns the unit of measure used for this coordinate system axis.-
Methods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
-
-
-
-
Method Detail
-
getAbbreviation
@UML(identifier="axisAbbrev", obligation=MANDATORY, specification=ISO_19111) String getAbbreviation()
Returns the abbreviation used for this coordinate system axes. This abbreviation is also used to identify the coordinates in coordinate tuple. Examples are “X” and “Y”.- Returns:
- the coordinate system axis abbreviation.
-
getDirection
@UML(identifier="axisDirection", obligation=MANDATORY, specification=ISO_19111) AxisDirection getDirection()
Returns the 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
EngineeringCRS
often requires specific descriptions of the directions of its coordinate system axes.- Returns:
- the coordinate system axis direction.
-
getUnit
@UML(identifier="axisUnitID", obligation=MANDATORY, specification=ISO_19111) Unit<?> getUnit()
Returns the unit of measure used for this coordinate system axis. The value of a 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.
-
getMinimumValue
@UML(identifier="minimumValue", obligation=OPTIONAL, specification=ISO_19111) default double getMinimumValue()
Returns the minimum value normally allowed for this axis, in the unit of measure for the axis. If there is no minimum value, then this method returns negative infinity.- Returns:
- the minimum value, or
Double.NEGATIVE_INFINITY
if none.
-
getMaximumValue
@UML(identifier="maximumValue", obligation=OPTIONAL, specification=ISO_19111) default double getMaximumValue()
Returns the maximum value normally allowed for this axis, in the unit of measure for the axis. If there is no maximum value, then this method returns positive infinity.- Returns:
- the maximum value, or
Double.POSITIVE_INFINITY
if none.
-
getRangeMeaning
@UML(identifier="rangeMeaning", obligation=CONDITIONAL, specification=ISO_19111) default RangeMeaning getRangeMeaning()
Returns the meaning of axis value range specified by the minimum and maximum values. This element shall be omitted when both minimum and maximum values are omitted. It may be included when minimum and/or maximum values are included. If this element is omitted when minimum or maximum values are included, the meaning is unspecified.- Returns:
- the range meaning, or
null
in none. - See Also:
RangeMeaning.EXACT
,RangeMeaning.WRAPAROUND
-
-