org.geotoolkit.referencing.crs
Class DefaultEngineeringCRS

Object
  FormattableObject
      AbstractIdentifiedObject
          AbstractReferenceSystem
              AbstractCRS
                  AbstractSingleCRS
                      DefaultEngineeringCRS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, LenientComparable, CoordinateReferenceSystem, EngineeringCRS, SingleCRS, IdentifiedObject, ReferenceSystem

@Immutable
public class DefaultEngineeringCRS
extends AbstractSingleCRS
implements EngineeringCRS

A contextually local coordinate reference system. It can be divided into two broad categories:

• earth-fixed systems applied to engineering activities on or near the surface of the earth;
• CRSs on moving platforms such as road vehicles, vessels, aircraft, or spacecraft.

Used with CS type(s)

Cartesian, Affine, Ellipsoidal, Spherical, Cylindrical, Polar, Vertical, Linear

Since:

1.2

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys)

See Also:

Serialized Form

Module:

referencing/geotk-referencing (download)

View source code for this class

Field Summary

static DefaultEngineeringCRS	CARTESIAN_2D A two-dimensional Cartesian coordinate reference system with x, y axes in metres.
static DefaultEngineeringCRS	CARTESIAN_3D A three-dimensional Cartesian coordinate reference system with x, y, z axes in metres.
static DefaultEngineeringCRS	GENERIC_2D A two-dimensional wildcard coordinate system with x, y axes in metres.
static DefaultEngineeringCRS	GENERIC_3D A three-dimensional wildcard coordinate system with x, y, z axes in metres.

Fields inherited from class FormattableObject

EPSG, GEOTIFF, INTERNAL, OGC, SINGLE_LINE

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

DefaultEngineeringCRS(EngineeringCRS crs)
Constructs a new enginnering CRS with the same values than the specified one.

DefaultEngineeringCRS(Map<String,?> properties, EngineeringDatum datum, CoordinateSystem cs)
Constructs an engineering CRS from a set of properties.

DefaultEngineeringCRS(String name, EngineeringDatum datum, CoordinateSystem cs)
Constructs an engineering CRS from a name.

Method Summary

static DefaultEngineeringCRS	castOrCopy(EngineeringCRS object) Returns a Geotk CRS implementation with the same values than the given arbitrary implementation.
String	formatWKT(Formatter formatter) Formats the inner part of a Well Known Text (WKT) element.
EngineeringDatum	getDatum() Returns the datum.

Methods inherited from class AbstractSingleCRS

computeHashCode, equals, getAxis, getDimension

Methods inherited from class AbstractCRS

distance, getCoordinateSystem

Methods inherited from class AbstractReferenceSystem

getDomainOfValidity, getScope

Methods inherited from class AbstractIdentifiedObject

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

Methods inherited from class FormattableObject

getDefaultIndentation, print, setDefaultIndentation, toString, toWKT, toWKT, toWKT, toWKT

Methods inherited from class Object

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

Methods inherited from interface SingleCRS

getCoordinateSystem

Methods inherited from interface ReferenceSystem

getDomainOfValidity, getScope

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Detail

CARTESIAN_2D

public static final DefaultEngineeringCRS CARTESIAN_2D

A two-dimensional Cartesian coordinate reference system with x, y axes in metres. By default, this CRS has no transformation path to any other CRS (i.e. a map using this CS can't be reprojected to a geographic coordinate reference system for example).

CARTESIAN_3D

public static final DefaultEngineeringCRS CARTESIAN_3D

A three-dimensional Cartesian coordinate reference system with x, y, z axes in metres. By default, this CRS has no transformation path to any other CRS (i.e. a map using this CS can't be reprojected to a geographic coordinate reference system for example).

GENERIC_2D

public static final DefaultEngineeringCRS GENERIC_2D

A two-dimensional wildcard coordinate system with x, y axes in metres. At the difference of CARTESIAN_2D, this coordinate system is treated specially by the default coordinate operation factory with loose transformation rules: if no transformation path were found (for example through a derived CRS), then the transformation from this CRS to any CRS with a compatible number of dimensions is assumed to be the identity transform. This CRS is useful as a kind of wildcard when no CRS were explicitly specified.

GENERIC_3D

public static final DefaultEngineeringCRS GENERIC_3D

A three-dimensional wildcard coordinate system with x, y, z axes in metres. At the difference of CARTESIAN_3D, this coordinate system is treated specially by the default coordinate operation factory with loose transformation rules: if no transformation path were found (for example through a derived CRS), then the transformation from this CRS to any CRS with a compatible number of dimensions is assumed to be the identity transform. This CRS is useful as a kind of wildcard when no CRS were explicitly specified.

Constructor Detail

DefaultEngineeringCRS

public DefaultEngineeringCRS(EngineeringCRS crs)

Constructs a new enginnering CRS with the same values than the specified one. This copy constructor provides a way to convert 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:

crs - The CRS to copy.

Since:

2.2

DefaultEngineeringCRS

public DefaultEngineeringCRS(String name,
                             EngineeringDatum datum,
                             CoordinateSystem cs)

Constructs an engineering CRS from a name.

Parameters:

name - The name.

datum - The datum.

cs - The coordinate system.

DefaultEngineeringCRS

public DefaultEngineeringCRS(Map<String,?> properties,
                             EngineeringDatum datum,
                             CoordinateSystem cs)

Constructs an engineering CRS from a set of properties. The properties are given unchanged to the super-class constructor.

Parameters:

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

datum - The datum.

cs - The coordinate system.

Method Detail

castOrCopy

public static DefaultEngineeringCRS castOrCopy(EngineeringCRS object)

Returns a Geotk CRS 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 get as 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

getDatum

public EngineeringDatum getDatum()

Returns the datum.

Specified by:

getDatum in interface EngineeringCRS

Specified by:

getDatum in interface SingleCRS

Overrides:

getDatum in class AbstractSingleCRS

Returns:

The datum.

formatWKT

public String formatWKT(Formatter formatter)

Formats the inner part of a Well Known Text (WKT) element.

Specified by:

formatWKT in interface Formattable

Overrides:

formatWKT in class AbstractCRS

Parameters:

formatter - The formatter to use.

Returns:

The name of the WKT element type, which is "LOCAL_CS".

See Also:

FormattableObject.toWKT(), FormattableObject.toString()