org.geotools.referencing.cs

Class DefaultSphericalCS

Object

Formattable

AbstractIdentifiedObject

AbstractCS

DefaultSphericalCS

All Implemented Interfaces:

Serializable, CoordinateSystem, SphericalCS, IdentifiedObject

public class DefaultSphericalCS
extends AbstractCS
implements SphericalCS

A three-dimensional coordinate system with one distance measured from the origin and two angular coordinates. Not to be confused with an ellipsoidal coordinate system based on an ellipsoid "degenerated" into a sphere. A SphericalCS shall have three axis.

Used with CRS type(s)
Geocentric, Engineering

Since:

2.1

Author:

Martin Desruisseaux (IRD)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DefaultSphericalCS	GEOCENTRIC A three-dimensional spherical CS with longitude, latitude, radius axis.

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
DefaultSphericalCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a set of properties.
DefaultSphericalCS(SphericalCS cs) Constructs a new coordinate system with the same values than the specified one.
DefaultSphericalCS(String name, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a name.

Method Summary

Modifier and Type	Method and Description
protected boolean	isCompatibleDirection(AxisDirection direction) Returns true if the specified axis direction is allowed for this coordinate system.

Methods inherited from class AbstractCS

distance, 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

GEOCENTRIC

public static DefaultSphericalCS GEOCENTRIC

A three-dimensional spherical CS with longitude, latitude, radius axis.

See Also:

DefaultCartesianCS.GEOCENTRIC

Constructor Detail

DefaultSphericalCS

public DefaultSphericalCS(String name,
                          CoordinateSystemAxis axis0,
                          CoordinateSystemAxis axis1,
                          CoordinateSystemAxis axis2)

Constructs a three-dimensional coordinate system from a name.

Parameters:

name - The coordinate system name.

axis0 - The first axis.

axis1 - The second axis.

axis2 - The third axis.

DefaultSphericalCS

public DefaultSphericalCS(SphericalCS 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

DefaultSphericalCS

public DefaultSphericalCS(Map<String,?> properties,
                          CoordinateSystemAxis axis0,
                          CoordinateSystemAxis axis1,
                          CoordinateSystemAxis axis2)

Constructs a three-dimensional 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".

axis0 - The first axis.

axis1 - The second axis.

axis2 - The third 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 all directions except temporal ones (i.e. FUTURE and PAST).

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.