Module org.opengis.geoapi

Package org.opengis.referencing.cs

Class AxisDirection

Object

CodeList<AxisDirection>

AxisDirection

All Implemented Interfaces:

Serializable, Comparable<AxisDirection>, ControlledVocabulary

@UML(identifier="AxisDirection",
     specification=ISO_19111)
public final class AxisDirection
extends CodeList<AxisDirection>

The direction of positive increase in the coordinate value for a coordinate system axis. This direction is exact in some cases, and is approximate in other cases.

Some coordinate systems use non-standard orientations. For example, the first axis in South African grids usually points West, instead of East. This information is relevant for algorithms converting South African grid coordinates into Lat/Long.

Since:

1.0

See Also:

• CoordinateSystemAxis.getDirection()
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final AxisDirection	AFT	Axis positive direction is aft.
static final AxisDirection	AWAY_FROM	Axis positive direction is away from the object.
static final AxisDirection	CLOCKWISE	Axis positive direction is clockwise from a specified direction.
static final AxisDirection	COLUMN_NEGATIVE	Axis positive direction is towards lower pixel column.
static final AxisDirection	COLUMN_POSITIVE	Axis positive direction is towards higher pixel column.
static final AxisDirection	COUNTER_CLOCKWISE	Axis positive direction is counter clockwise from a specified direction.
static final AxisDirection	DISPLAY_DOWN	Axis positive direction is towards bottom of approximately vertical display surface.
static final AxisDirection	DISPLAY_LEFT	Axis positive direction is left in display.
static final AxisDirection	DISPLAY_RIGHT	Axis positive direction is right in display.
static final AxisDirection	DISPLAY_UP	Axis positive direction is towards top of approximately vertical display surface.
static final AxisDirection	DOWN	Axis positive direction is down relative to gravity.
static final AxisDirection	EAST	Axis positive direction is π/2 radians clockwise from north.
static final AxisDirection	EAST_NORTH_EAST	Axis positive direction is approximately east-north-east.
static final AxisDirection	EAST_SOUTH_EAST	Axis positive direction is approximately east-south-east.
static final AxisDirection	FORWARD	Axis positive direction is forward.
static final AxisDirection	FUTURE	Axis positive direction is towards the future.
static final AxisDirection	GEOCENTRIC_X	Axis positive direction is toward geocentric X.
static final AxisDirection	GEOCENTRIC_Y	Axis positive direction is toward geocentric Y.
static final AxisDirection	GEOCENTRIC_Z	Axis positive direction is toward geocentric Z.
static final AxisDirection	NORTH	Axis positive direction is north.
static final AxisDirection	NORTH_EAST	Axis positive direction is approximately north-east.
static final AxisDirection	NORTH_NORTH_EAST	Axis positive direction is approximately north-north-east.
static final AxisDirection	NORTH_NORTH_WEST	Axis positive direction is approximately north-north-west.
static final AxisDirection	NORTH_WEST	Axis positive direction is approximately north-west.
static final AxisDirection	OTHER	Deprecated. Replaced by UNSPECIFIED in ISO 19111:2019.
static final AxisDirection	PAST	Axis positive direction is towards the past.
static final AxisDirection	PORT	Axis positive direction is port.
static final AxisDirection	ROW_NEGATIVE	Axis positive direction is towards lower pixel row.
static final AxisDirection	ROW_POSITIVE	Axis positive direction is towards higher pixel row.
static final AxisDirection	SOUTH	Axis positive direction is π radians clockwise from north.
static final AxisDirection	SOUTH_EAST	Axis positive direction is approximately south-east.
static final AxisDirection	SOUTH_SOUTH_EAST	Axis positive direction is approximately south-south-east.
static final AxisDirection	SOUTH_SOUTH_WEST	Axis positive direction is approximately south-south-west.
static final AxisDirection	SOUTH_WEST	Axis positive direction is approximately south-west.
static final AxisDirection	STARBOARD	Axis positive direction is starboard.
static final AxisDirection	TOWARDS	Axis positive direction is towards the object.
static final AxisDirection	UNSPECIFIED	Axis positive direction is unspecified.
static final AxisDirection	UP	Axis positive direction is up relative to gravity.
static final AxisDirection	WEST	Axis positive direction is 3π/2 radians clockwise from north.
static final AxisDirection	WEST_NORTH_WEST	Axis positive direction is approximately west-north-west.
static final AxisDirection	WEST_SOUTH_WEST	Axis positive direction is approximately west-south-west.

Method Summary

Modifier and Type	Method	Description
AxisDirection[]	family()	Returns the list of codes of the same kind as this code list element.
Optional<AxisDirection>	opposite()	Returns the direction of negative coordinate values.
static AxisDirection	valueOf(String code)	Returns the axis direction that matches the given string, or returns a new one if none match it.
static AxisDirection[]	values()	Returns the list of AxisDirections.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

OTHER

@Deprecated(since="3.1")
@UML(identifier="CS_AxisOrientationEnum.CS_AO_Other",
     obligation=CONDITIONAL,
     specification=OGC_01009)
public static final AxisDirection OTHER

Deprecated.

Replaced by UNSPECIFIED in ISO 19111:2019.

Unknown or unspecified axis orientation.

NORTH

@UML(identifier="north",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection NORTH

Axis positive direction is north. In a geographic or projected CRS, north is defined through the geodetic reference frame. In an engineering CRS, north may be defined with respect to an engineering object rather than a geographical direction.

NORTH_NORTH_EAST

@UML(identifier="northNorthEast",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection NORTH_NORTH_EAST

Axis positive direction is approximately north-north-east.

NORTH_EAST

@UML(identifier="northEast",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection NORTH_EAST

Axis positive direction is approximately north-east.

EAST_NORTH_EAST

@UML(identifier="eastNorthEast",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection EAST_NORTH_EAST

Axis positive direction is approximately east-north-east.

EAST

@UML(identifier="east",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection EAST

Axis positive direction is π/2 radians clockwise from north. This is usually used for grid X coordinates and for longitude.

EAST_SOUTH_EAST

@UML(identifier="eastSouthEast",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection EAST_SOUTH_EAST

Axis positive direction is approximately east-south-east.

SOUTH_EAST

@UML(identifier="southEast",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection SOUTH_EAST

Axis positive direction is approximately south-east.

SOUTH_SOUTH_EAST

@UML(identifier="southSouthEast",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection SOUTH_SOUTH_EAST

Axis positive direction is approximately south-south-east.

SOUTH

@UML(identifier="south",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection SOUTH

Axis positive direction is π radians clockwise from north.

SOUTH_SOUTH_WEST

@UML(identifier="southSouthWest",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection SOUTH_SOUTH_WEST

Axis positive direction is approximately south-south-west.

SOUTH_WEST

@UML(identifier="southWest",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection SOUTH_WEST

Axis positive direction is approximately south-west.

WEST_SOUTH_WEST

@UML(identifier="westSouthWest",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection WEST_SOUTH_WEST

Axis positive direction is approximately west-south-west.

WEST

@UML(identifier="west",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection WEST

Axis positive direction is 3π/2 radians clockwise from north. This is usually used for Grid X coordinates and Longitude.

WEST_NORTH_WEST

@UML(identifier="westNorthWest",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection WEST_NORTH_WEST

Axis positive direction is approximately west-north-west.

NORTH_WEST

@UML(identifier="northWest",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection NORTH_WEST

Axis positive direction is approximately north-west.

NORTH_NORTH_WEST

@UML(identifier="northNorthWest",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection NORTH_NORTH_WEST

Axis positive direction is approximately north-north-west.

UP

@UML(identifier="up",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection UP

Axis positive direction is up relative to gravity. This is used for vertical coordinate systems.

DOWN

@UML(identifier="down",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection DOWN

Axis positive direction is down relative to gravity. This is used for vertical coordinate systems.

GEOCENTRIC_X

@UML(identifier="geocentricX",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection GEOCENTRIC_X

Axis positive direction is toward geocentric X. This is the direction in the equatorial plane from the center of the modeled planet towards the intersection of the equator with the prime meridian.

GEOCENTRIC_Y

@UML(identifier="geocentricY",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection GEOCENTRIC_Y

Axis positive direction is toward geocentric Y. This is the direction in the equatorial plane from the center of the modeled planet towards the intersection of the equator and the meridian π/2 radians eastwards from the prime meridian.

GEOCENTRIC_Z

@UML(identifier="geocentricZ",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection GEOCENTRIC_Z

Axis positive direction is toward geocentric Z. This is the direction from the center of the modeled planet parallel to its rotation axis and towards its north pole.

COLUMN_POSITIVE

@UML(identifier="columnPositive",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection COLUMN_POSITIVE

Axis positive direction is towards higher pixel column.

COLUMN_NEGATIVE

@UML(identifier="columnNegative",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection COLUMN_NEGATIVE

Axis positive direction is towards lower pixel column.

ROW_POSITIVE

@UML(identifier="rowPositive",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection ROW_POSITIVE

Axis positive direction is towards higher pixel row.

ROW_NEGATIVE

@UML(identifier="rowNegative",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection ROW_NEGATIVE

Axis positive direction is towards lower pixel row.

DISPLAY_RIGHT

@UML(identifier="displayRight",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection DISPLAY_RIGHT

Axis positive direction is right in display.

DISPLAY_LEFT

@UML(identifier="displayLeft",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection DISPLAY_LEFT

Axis positive direction is left in display.

DISPLAY_UP

@UML(identifier="displayUp",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection DISPLAY_UP

Axis positive direction is towards top of approximately vertical display surface.

DISPLAY_DOWN

@UML(identifier="displayDown",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection DISPLAY_DOWN

Axis positive direction is towards bottom of approximately vertical display surface.

FORWARD

@UML(identifier="forward",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection FORWARD

Axis positive direction is forward. For an observer at the center of the object this will be towards its front, bow or nose.

Since:

3.1

AFT

@UML(identifier="aft",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection AFT

Axis positive direction is aft. For an observer at the center of the object this will be towards its back, stern or tail.

Since:

3.1

PORT

@UML(identifier="port",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection PORT

Axis positive direction is port. For an observer looking forward from the center of the object this will be towards its left.

Since:

3.1

STARBOARD

@UML(identifier="starboard",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection STARBOARD

Axis positive direction is starboard. For an observer looking forward from the center of the object this will be towards its right.

Since:

3.1

CLOCKWISE

@UML(identifier="clockwise",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection CLOCKWISE

Axis positive direction is clockwise from a specified direction.

Since:

3.1

COUNTER_CLOCKWISE

@UML(identifier="counterClockwise",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection COUNTER_CLOCKWISE

Axis positive direction is counter clockwise from a specified direction.

Since:

3.1

TOWARDS

@UML(identifier="towards",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection TOWARDS

Axis positive direction is towards the object.

Since:

3.1

AWAY_FROM

@UML(identifier="awayFrom",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection AWAY_FROM

Axis positive direction is away from the object.

Since:

3.1

FUTURE

@UML(identifier="future",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection FUTURE

Axis positive direction is towards the future. This is used for temporal coordinate systems.

PAST

@UML(identifier="past",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection PAST

Axis positive direction is towards the past. This is used for temporal coordinate systems.

UNSPECIFIED

@UML(identifier="unspecified",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final AxisDirection UNSPECIFIED

Axis positive direction is unspecified.

Since:

3.1

Method Details

opposite

public Optional<AxisDirection> opposite()

Returns the direction of negative coordinate values. For example, the opposite of NORTH is SOUTH and the opposite of FUTURE is PAST. The opposite of the opposite (if present) is always this.

Returns:

direction of negative coordinate values.

Since:

3.1

values

public static AxisDirection[] values()

Returns the list of AxisDirections.

Returns:

the list of codes declared in the current JVM.

family

public AxisDirection[] family()

Returns the list of codes of the same kind as this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<AxisDirection>

Returns:

all code values for this code list.

valueOf

public static AxisDirection valueOf(String code)

Returns the axis direction that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.