Module org.opengis.geoapi

Package org.opengis.referencing.crs

Interface ParametricCRS

All Superinterfaces:

CoordinateReferenceSystem, IdentifiedObject, ReferenceSystem, SingleCRS

@UML(identifier="ParametricCRS",
     specification=ISO_19111)
public interface ParametricCRS
extends SingleCRS

A 1-dimensional CRS which uses parameter values or functions. A CRS shall be of the parametric type if a physical or material property or function is used as the dimension. The values or functions can vary monotonically with height.

Examples: Pressure in meteorological applications, or density (isopycnals) in oceanographic applications.

Permitted coordinate systems

This type of CRS can be used with coordinate systems of type ParametricCS only.

Since:

3.1

See Also:

• CRSAuthorityFactory.createParametricCRS(String)
• CRSFactory.createParametricCRS(Map, ParametricDatum, DatumEnsemble, ParametricCS)

Field Summary

Fields inherited from interface org.opengis.referencing.IdentifiedObject

ALIAS_KEY, DOMAINS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Fields inherited from interface org.opengis.referencing.ReferenceSystem

DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY

Method Summary

Modifier and Type	Method	Description
ParametricCS	getCoordinateSystem()	Returns the coordinate system, which shall be parametric.
ParametricDatum	getDatum()	Returns the datum, which shall be parametric.
default DatumEnsemble<ParametricDatum>	getDatumEnsemble()	Returns the datum ensemble, which shall have parametric datum members.

Methods inherited from interface org.opengis.referencing.IdentifiedObject

getAlias, getDomains, getIdentifiers, getName, getRemarks, toWKT

Methods inherited from interface org.opengis.referencing.ReferenceSystem

getDomainOfValidity, getScope

Method Details

getCoordinateSystem

@UML(identifier="coordinateSystem",
     obligation=MANDATORY,
     specification=ISO_19111)
ParametricCS getCoordinateSystem()

Returns the coordinate system, which shall be parametric.

Specified by:

getCoordinateSystem in interface CoordinateReferenceSystem

Specified by:

getCoordinateSystem in interface SingleCRS

Returns:

the parametric coordinate system.

getDatum

@UML(identifier="datum",
     obligation=CONDITIONAL,
     specification=ISO_19111)
ParametricDatum getDatum()

Returns the datum, which shall be parametric. This property may be null if this CRS is related to an object identified only by a datum ensemble.

Specified by:

getDatum in interface SingleCRS

Returns:

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

Condition:

Mandatory if the datum ensemble is not documented.

getDatumEnsemble

@UML(identifier="datum",
     obligation=CONDITIONAL,
     specification=ISO_19111)
default DatumEnsemble<ParametricDatum> getDatumEnsemble()

Returns the datum ensemble, which shall have parametric datum members. This property may be null if this CRS is related to an object identified only by a single datum.

The default implementation returns null.

Specified by:

getDatumEnsemble in interface SingleCRS

Returns:

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

Condition:

Mandatory if the datum is not documented.