Class DefaultEngineeringCRS

Object

FormattableObject

AbstractIdentifiedObject

AbstractReferenceSystem

AbstractCRS

DefaultEngineeringCRS

All Implemented Interfaces:

Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Coordinate­Reference­System, Engineering­CRS, Single­CRS, Identified­Object, Reference­System

public class DefaultEngineeringCRS
extends AbstractCRS
implements EngineeringCRS

A 1-, 2- or 3-dimensional 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 datum type: Engineering.
Used with coordinate system types: Affine, Cartesian, Cylindrical, Linear. Polar, Spherical or User Defined.

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.

Since:

0.4

See Also:

• Default­Engineering­Datum
• Geodetic­Authority­Factory.create­Engineering­CRS(String)
• Serialized Form

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
	Default­Engineering­CRS(Map<String,?> properties, Engineering­Datum datum, Default­Datum­Ensemble<Engineering­Datum> ensemble, Coordinate­System cs)	Creates a coordinate reference system from the given properties, datum and coordinate system.
	Default­Engineering­CRS(Map<String,?> properties, Engineering­Datum datum, Coordinate­System cs)	Deprecated, for removal: This API element is subject to removal in a future version. A Default­Datum­Ensemble argument has been added.
protected	Default­Engineering­CRS(Engineering­CRS crs)	Constructs a new coordinate reference system with the same values as the specified one.

Method Summary

Modifier and Type	Method	Description
static Default­Engineering­CRS	cast­Or­Copy(Engineering­CRS object)	Returns a SIS coordinate reference system implementation with the same values as the given arbitrary implementation.
Default­Engineering­CRS	for­Convention(Axes­Convention convention)	Returns a CRS equivalent to this one but with axes rearranged according the given convention.
protected String	format­To(Formatter formatter)	Formats this CRS as a Well Known Text Engineering­CRS[…] element.
Engineering­Datum	get­Datum()	Returns the identification of the origin of this engineering (or local) CRS.
Default­Datum­Ensemble<Engineering­Datum>	get­Datum­Ensemble()	Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other.
Class<? extends Engineering­CRS>	get­Interface()	Returns the GeoAPI interface implemented by this class.

Methods inherited from class AbstractCRS

cast­Or­Copy, get­Coordinate­System

Methods inherited from class AbstractReferenceSystem

get­Domain­Of­Validity, get­Scope

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Methods inherited from interface ReferenceSystem

get­Domain­Of­Validity, get­Scope

Methods inherited from interface SingleCRS

get­Coordinate­System

Constructor Details

DefaultEngineeringCRS

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

Creates a coordinate reference system from the given properties, datum and coordinate system. At least one of the datum and ensemble arguments shall be non-null. The properties given in argument follow the same rules as for the super-class constructor. The following table is a reminder of main (not all) properties:

Recognized properties (non exhaustive list)

Property name	Value type	Returned by
"name"	ReferenceIdentifier or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	ReferenceIdentifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the coordinate reference system.

datum - the datum, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the coordinate system.

Since:

1.5

See Also:

• Geodetic­Object­Factory.create­Engineering­CRS(Map, Engineering­Datum, Default­Datum­Ensemble, Coordinate­System)

DefaultEngineeringCRS

@Deprecated(since="1.5",
            forRemoval=true)
public DefaultEngineeringCRS(Map<String,?> properties,
 EngineeringDatum datum,
 CoordinateSystem cs)

Deprecated, for removal: This API element is subject to removal in a future version.

A Default­Datum­Ensemble argument has been added.

DefaultEngineeringCRS

protected DefaultEngineeringCRS(EngineeringCRS crs)

Constructs a new coordinate reference system with the same values as the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS 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 coordinate reference system to copy.

See Also:

• cast­Or­Copy(Engineering­CRS)

Method Details

castOrCopy

public static DefaultEngineeringCRS castOrCopy(EngineeringCRS object)

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

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

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

getInterface

public Class<? extends EngineeringCRS> getInterface()

Returns the GeoAPI interface implemented by this class. The SIS implementation returns Engineering­CRS.class.

Note for implementers

Subclasses usually do not need to override this method since GeoAPI does not define Engineering­CRS sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.

Returns:

Engineering­CRS.class or a user-defined sub-interface.

getDatum

public EngineeringDatum getDatum()

Returns the identification of the origin of this engineering (or local) CRS. This property may be null if this CRS is related to an object identified only by a datum ensemble.

Specified by:

get­Datum in interface Engineering­CRS

Specified by:

get­Datum in interface Single­CRS

Returns:

the engineering datum, or null if this CRS is related to an object identified only by a datum ensemble.

getDatumEnsemble

public DefaultDatumEnsemble<EngineeringDatum> getDatumEnsemble()

Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other. This property may be null if this CRS is related to an object identified only by a single datum.

Warning: in a future SIS version, the return type may be changed to the org.opengis.referencing.datum.Datum­Ensemble interface. This change is pending GeoAPI revision.

Returns:

the datum ensemble, or null if this CRS is related to an object identified only by a single datum.

Since:

1.5

forConvention

public DefaultEngineeringCRS forConvention(AxesConvention convention)

Returns a CRS equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returns this.

Overrides:

for­Convention in class Abstract­CRS

Parameters:

convention - the axes convention for which a coordinate reference system is desired.

Returns:

a coordinate reference system compatible with the given convention (may be this).

See Also:

• Abstract­CS.for­Convention(Axes­Convention)

formatTo

protected String formatTo(Formatter formatter)

Formats this CRS as a Well Known Text Engineering­CRS[…] element.

Overrides:

format­To in class Abstract­CRS

Parameters:

formatter - the formatter where to format the inner content of this WKT element.

Returns:

"Engineering­CRS" (WKT 2) or "Local_CS" (WKT 1).

See Also:

• Formattable­Object.to­WKT()
• Formattable­Object.to­String()