org.geotoolkit.referencing.cs
Class DefaultSphericalCS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractCS
              DefaultSphericalCS

All Implemented Interfaces:

Serializable, Formattable, LenientComparable, CoordinateSystem, SphericalCS, IdentifiedObject

@Immutable
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.0

Version:

3.18

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

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 FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

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

protected boolean	isCompatibleDirection(AxisDirection direction) Returns true if the specified axis direction is allowed for this coordinate system.
static DefaultSphericalCS	wrap(SphericalCS object) Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation.

Methods inherited from class AbstractCS

computeHashCode, distance, equals, formatWKT, getAxis, getDimension, isCompatibleUnit, standard, swapAndScaleAxis

Methods inherited from class AbstractIdentifiedObject

equals, equals, equals, equals, getAlias, getIdentifier, getIdentifier, getIdentifiers, getName, getName, getName, getProperties, getProperties, getRemarks, hashCode, nameMatches, nameMatches, nameMatches

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, 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 final 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 Geotk 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.

Parameters:

cs - The coordinate system to copy.

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

wrap

public static DefaultSphericalCS wrap(SphericalCS object)

Returns a Geotk coordinate system implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object.

Parameters:

object - The object to wrap in a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

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.