Class DefaultParametricCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultParametricCRS
- All Implemented Interfaces:
- Serializable,- Formattable,- Deprecable,- LenientComparable,- Printable,- CoordinateReferenceSystem,- SingleCRS,- IdentifiedObject,- ReferenceSystem
A 1-dimensional coordinate reference system which uses parameter values or functions.
 Parametric CRS can be used for physical properties or functions that vary monotonically with height.
 A typical example is the pressure in meteorological applications.
 
Used with datum type:
   Parametric.
 Used with coordinate system type:
   Parametric.
 
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.7
- See Also:
- 
Field SummaryFields inherited from class AbstractIdentifiedObjectDEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEYFields inherited from interface IdentifiedObjectALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEYFields inherited from interface ReferenceSystemDOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
- 
Constructor SummaryConstructorsModifierConstructorDescriptionDefaultParametricCRS(Map<String, ?> properties, DefaultParametricDatum datum, DefaultParametricCS cs) Deprecated, for removal: This API element is subject to removal in a future version.DefaultParametricCRS(Map<String, ?> properties, DefaultParametricDatum datum, DefaultDatumEnsemble<DefaultParametricDatum> ensemble, DefaultParametricCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protectedConstructs a new coordinate reference system with the same values as the specified one.
- 
Method SummaryModifier and TypeMethodDescriptionforConvention(AxesConvention convention) Returns a CRS equivalent to this one but with axes rearranged according the given convention.protected StringFormats this CRS as a Well Known TextParametricCRS[…]element.Returns the coordinate system.Returns the reference surface used as the origin of this CRS.Returns a collection of datums which, for low accuracy requirements, may be considered to be insignificantly different from each other.Class<? extends SingleCRS> Returns the GeoAPI interface implemented by this class.Methods inherited from class AbstractCRScastOrCopyMethods inherited from class AbstractReferenceSystemgetDomainOfValidity, getScopeMethods inherited from class AbstractIdentifiedObjectcastOrCopy, equals, formatTo, getAlias, getDescription, getDomains, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObjectprint, toString, toString, toWKTMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface IdentifiedObjectgetAlias, getIdentifiers, getName, getRemarks, toWKTMethods inherited from interface ReferenceSystemgetDomainOfValidity, getScope
- 
Constructor Details- 
DefaultParametricCRSpublic DefaultParametricCRS(Map<String, ?> properties, DefaultParametricDatum datum, DefaultDatumEnsemble<DefaultParametricDatum> ensemble, DefaultParametricCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system. At least one of thedatumandensemblearguments 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" IdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" Identifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"domains" DefaultObjectDomain(optionally as array)AbstractIdentifiedObject.getDomains()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()Warning: in a future SIS version, the parameter types may be changed toorg.opengis.referencing.datum.ParametricDatumandorg.opengis.referencing.cs.ParametricCSThose change are pending GeoAPI revision.- Parameters:
- properties- the properties to be given to the coordinate reference system.
- datum- the datum, or- nullif 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- nullif there is no such ensemble.
- cs- the coordinate system.
- Since:
- 1.5
 
- 
DefaultParametricCRS@Deprecated(since="1.5", forRemoval=true) public DefaultParametricCRS(Map<String, ?> properties, DefaultParametricDatum datum, DefaultParametricCS cs) Deprecated, for removal: This API element is subject to removal in a future version.ADefaultDatumEnsembleargument has been added.
- 
DefaultParametricCRSConstructs 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. Warning: in a future SIS version, the parameter type may be changed toorg.opengis.referencing.crs.ParametricCRS. This change is pending GeoAPI revision.- Parameters:
- crs- the coordinate reference system to copy.
 
 
- 
- 
Method Details- 
getDatumReturns the reference surface used as the origin of this CRS. This property may be null if this CRS is related to an object identified only by a datum ensemble.- Specified by:
- getDatumin interface- SingleCRS
- Returns:
- the parametric datum, or nullif this CRS is related to an object identified only by a datum ensemble.
 
- 
getDatumEnsembleReturns 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 theorg.opengis.referencing.datum.DatumEnsembleinterface. This change is pending GeoAPI revision.- Returns:
- the datum ensemble, or nullif this CRS is related to an object identified only by a single datum.
- Since:
- 1.5
 
- 
getCoordinateSystemReturns the coordinate system.- Specified by:
- getCoordinateSystemin interface- CoordinateReferenceSystem
- Specified by:
- getCoordinateSystemin interface- SingleCRS
- Overrides:
- getCoordinateSystemin class- AbstractCRS
- Returns:
- the coordinate system.
 
- 
forConventionReturns 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 returnsthis.- Overrides:
- forConventionin class- AbstractCRS
- 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:
 
- 
formatToFormats this CRS as a Well Known TextParametricCRS[…]element.Compatibility noteParametricCRSis defined in the WKT 2 specification only.- Overrides:
- formatToin class- AbstractCRS
- Parameters:
- formatter- the formatter where to format the inner content of this WKT element.
- Returns:
- "ParametricCRS".
- See Also:
 
- 
getInterfaceReturns the GeoAPI interface implemented by this class. The default implementation returnsSingleCRS.class. Subclasses implementing a more specific GeoAPI interface shall override this method.- Overrides:
- getInterfacein class- AbstractCRS
- Returns:
- the coordinate reference system interface implemented by this class.
 
 
- 
DefaultDatumEnsembleargument has been added.