org.geotools.referencing.cs

Class DefaultVerticalCS

Object

Formattable

AbstractIdentifiedObject

AbstractCS

DefaultVerticalCS

All Implemented Interfaces:

Serializable, CoordinateSystem, VerticalCS, IdentifiedObject

public class DefaultVerticalCS
extends AbstractCS
implements VerticalCS

A one-dimensional coordinate system used to record the heights (or depths) of points. Such a coordinate system is usually dependent on the Earth's gravity field, perhaps loosely as when atmospheric pressure is the basis for the vertical coordinate system axis. An exact definition is deliberately not provided as the complexities of the subject fall outside the scope of this specification. A VerticalCS shall have one axis.

Used with CRS type(s)
Vertical, Engineering

Since:

2.1

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultVerticalCS	DEPTH A one-dimensional vertical CS with depth axis in metres.
static DefaultVerticalCS	ELLIPSOIDAL_HEIGHT A one-dimensional vertical CS with ellipsoidal height axis in metres.
static DefaultVerticalCS	GRAVITY_RELATED Deprecated. Renamed as GRAVITY_RELATED_HEIGHT.
static DefaultVerticalCS	GRAVITY_RELATED_HEIGHT A one-dimensional vertical CS with gravity-related height axis in metres.

Fields inherited from class AbstractIdentifiedObject

EMPTY_ALIAS_ARRAY, EMPTY_IDENTIFIER_ARRAY, IDENTIFIER_COMPARATOR, NAME_COMPARATOR, REMARKS_COMPARATOR

Fields inherited from class Formattable

SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Constructor and Description
DefaultVerticalCS(CoordinateSystemAxis axis) Constructs a coordinate system with the same properties than the specified axis.
DefaultVerticalCS(Map<String,?> properties, CoordinateSystemAxis axis) Constructs a coordinate system from a set of properties.
DefaultVerticalCS(String name, CoordinateSystemAxis axis) Constructs a coordinate system from a name.
DefaultVerticalCS(VerticalCS cs) Constructs a new coordinate system with the same values than the specified one.

Method Summary

Modifier and Type	Method and Description
Measure	distance(double[] coord1, double[] coord2) Computes the distance between two points.
protected boolean	isCompatibleDirection(AxisDirection direction) Returns true if the specified axis direction is allowed for this coordinate system.

Methods inherited from class AbstractCS

equals, formatWKT, getAxis, getDimension, hashCode, isCompatibleUnit, standard, swapAndScaleAxis

Methods inherited from class AbstractIdentifiedObject

asSet, ensureAngularUnit, ensureLinearUnit, ensureNonNull, ensureNonNull, ensureTimeUnit, equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, nameMatches, nameMatches, nameMatches

Methods inherited from class Formattable

cleanupThreadLocals, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CoordinateSystem

getAxis, getDimension

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

ELLIPSOIDAL_HEIGHT

public static DefaultVerticalCS ELLIPSOIDAL_HEIGHT

A one-dimensional vertical CS with ellipsoidal height axis in metres.

GRAVITY_RELATED_HEIGHT

public static DefaultVerticalCS GRAVITY_RELATED_HEIGHT

A one-dimensional vertical CS with gravity-related height axis in metres.

Since:

2.5

GRAVITY_RELATED

@Deprecated
public static DefaultVerticalCS GRAVITY_RELATED

Deprecated. Renamed as GRAVITY_RELATED_HEIGHT.

DEPTH

public static DefaultVerticalCS DEPTH

A one-dimensional vertical CS with depth axis in metres.

Constructor Detail

DefaultVerticalCS

public DefaultVerticalCS(VerticalCS cs)

Constructs a new coordinate system with the same values than the specified one. This copy constructor provides a way to wrap an arbitrary implementation into a Geotools one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API. This constructor performs a shallow copy, i.e. the properties are not cloned.

Since:

2.2

DefaultVerticalCS

public DefaultVerticalCS(CoordinateSystemAxis axis)

Constructs a coordinate system with the same properties than the specified axis. The inherited properties include the name and aliases.

Parameters:

axis - The axis.

Since:

2.5

DefaultVerticalCS

public DefaultVerticalCS(String name,
                         CoordinateSystemAxis axis)

Constructs a coordinate system from a name.

Parameters:

name - The coordinate system name.

axis - The axis.

DefaultVerticalCS

public DefaultVerticalCS(Map<String,?> properties,
                         CoordinateSystemAxis axis)

Constructs a coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor.

Parameters:

properties - Set of properties. Should contains at least "name".

axis - The axis.

Method Detail

isCompatibleDirection

protected boolean isCompatibleDirection(AxisDirection direction)

Returns true if the specified axis direction is allowed for this coordinate system. The default implementation accepts only vertical directions (i.e. UP and DOWN).

Overrides:

isCompatibleDirection in class AbstractCS

Parameters:

direction - The direction to test for compatibility.

Returns:

true if the given direction is compatible with this coordinate system.

distance

public Measure distance(double[] coord1,
                        double[] coord2)
                 throws MismatchedDimensionException

Computes the distance between two points.

Overrides:

distance in class AbstractCS

Parameters:

coord1 - Coordinates of the first point.

coord2 - Coordinates of the second point.

Returns:

The distance between coord1 and coord2.

Throws:

MismatchedDimensionException - if a coordinate doesn't have the expected dimension.