PROJ C++ API
Public Member Functions | Static Public Member Functions | List of all members
osgeo::proj::crs::ParametricCRS Class Reference

Contextually local coordinate reference system associated with an engineering datum. More...

#include <crs.hpp>

Inheritance diagram for osgeo::proj::crs::ParametricCRS:
Inheritance graph
[legend]
Collaboration diagram for osgeo::proj::crs::ParametricCRS:
Collaboration graph
[legend]

Public Member Functions

const datum::ParametricDatumNNPtr datum () const
 Return the datum::ParametricDatum associated with the CRS. More...
 
const cs::ParametricCSNNPtr coordinateSystem () const
 Return the cs::TemporalCS associated with the CRS. More...
 
bool isEquivalentTo (const util::IComparable *other, util::IComparable::Criterion criterion=util::IComparable::Criterion::STRICT) const override
 Returns whether an object is equivalent to another one. More...
 
CRSNNPtr shallowClone () const override
 Return a shallow clone of this object.
 
- Public Member Functions inherited from osgeo::proj::crs::SingleCRS
const datum::DatumPtrdatum () PROJ_CONST_DECL
 Return the datum::Datum associated with the CRS. More...
 
const datum::DatumEnsemblePtrdatumEnsemble () PROJ_CONST_DECL
 Return the datum::DatumEnsemble associated with the CRS. More...
 
const cs::CoordinateSystemNNPtrcoordinateSystem () PROJ_CONST_DECL
 Return the cs::CoordinateSystem associated with the CRS. More...
 
- Public Member Functions inherited from osgeo::proj::crs::CRS
GeodeticCRSPtr extractGeodeticCRS () const
 Return the GeodeticCRS of the CRS. More...
 
GeographicCRSPtr extractGeographicCRS () const
 Return the GeographicCRS of the CRS. More...
 
VerticalCRSPtr extractVerticalCRS () const
 Return the VerticalCRS of the CRS. More...
 
CRSNNPtr createBoundCRSToWGS84IfPossible (io::DatabaseContextPtr dbContext) const
 Returns potentially a BoundCRS, with a transformation to EPSG:4326, wrapping this CRS. More...
 
CRSNNPtr stripVerticalComponent () const
 Returns a CRS whose coordinate system does not contain a vertical component. More...
 
const BoundCRSPtrcanonicalBoundCRS () PROJ_CONST_DECL
 Return the BoundCRS potentially attached to this CRS. More...
 
- Public Member Functions inherited from osgeo::proj::common::ObjectUsage
const std::vector< ObjectDomainNNPtr > & domains () PROJ_CONST_DECL
 Return the domains of the object.
 
- Public Member Functions inherited from osgeo::proj::common::IdentifiedObject
const metadata::IdentifierNNPtrname () PROJ_CONST_DECL
 Return the name of the object. More...
 
const std::string & nameStr () PROJ_CONST_DECL
 Return the name of the object. More...
 
const std::vector< metadata::IdentifierNNPtr > & identifiers () PROJ_CONST_DECL
 Return the identifier(s) of the object. More...
 
const std::vector< util::GenericNameNNPtr > & aliases () PROJ_CONST_DECL
 Return the alias(es) of the object.
 
const std::string & remarks () PROJ_CONST_DECL
 Return the remarks.
 
bool isDeprecated () PROJ_CONST_DECL
 Return whether the object is deprecated. More...
 
std::string alias () PROJ_CONST_DECL
 Return the (first) alias of the object as a string. More...
 
int getEPSGCode () PROJ_CONST_DECL
 Return the EPSG code. More...
 
bool isEPSG (int code) PROJ_CONST_DECL
 Return whether the object has a identifiers() in the EPSG code space.
 
- Public Member Functions inherited from osgeo::proj::io::IWKTExportable
std::string exportToWKT (WKTFormatter *formatter) const
 

Static Public Member Functions

static ParametricCRSNNPtr create (const util::PropertyMap &properties, const datum::ParametricDatumNNPtr &datumIn, const cs::ParametricCSNNPtr &csIn)
 Instanciate a ParametricCRS from a datum and a coordinate system. More...
 
- Static Public Member Functions inherited from osgeo::proj::common::IdentifiedObject
static IdentifiedObjectNNPtr create (const util::PropertyMap &properties)
 Instanciate a new IdentifiedObject. More...
 

Additional Inherited Members

- Public Types inherited from osgeo::proj::util::IComparable
enum  Criterion { Criterion::STRICT, Criterion::EQUIVALENT }
 Comparison criterion. More...
 
- Static Public Attributes inherited from osgeo::proj::common::ObjectUsage
static const std::string SCOPE_KEY
 Key to set the scope of a common::ObjectUsage. More...
 
static const std::string DOMAIN_OF_VALIDITY_KEY
 Key to set the domain of validity of a common::ObjectUsage. More...
 
static const std::string OBJECT_DOMAIN_KEY
 Key to set the object domain(s) of a common::ObjectUsage. More...
 
- Static Public Attributes inherited from osgeo::proj::common::IdentifiedObject
static const std::string NAME_KEY
 Key to set the name of a common::IdentifiedObject. More...
 
static const std::string IDENTIFIERS_KEY
 Key to set the identifier(s) of a common::IdentifiedObject. More...
 
static const std::string ALIAS_KEY
 Key to set the alias(es) of a common::IdentifiedObject. More...
 
static const std::string REMARKS_KEY
 Key to set the remarks of a common::IdentifiedObject. More...
 
static const std::string DEPRECATED_KEY
 Key to set the deprecation flag of a common::IdentifiedObject. More...
 

Detailed Description

Contextually local coordinate reference system associated with an engineering datum.

This is applied either to activities on or near the surface of the Earth without geodetic corrections, or on moving platforms such as road vehicles vessels, aircraft or spacecraft, or as the internal CRS of an image.

Remarks
Implements ParametricCRS from ISO 19111:2018

Member Function Documentation

const cs::ParametricCSNNPtr osgeo::proj::crs::ParametricCRS::coordinateSystem ( ) const

Return the cs::TemporalCS associated with the CRS.

Returns
a TemporalCS
ParametricCRSNNPtr osgeo::proj::crs::ParametricCRS::create ( const util::PropertyMap properties,
const datum::ParametricDatumNNPtr datumIn,
const cs::ParametricCSNNPtr csIn 
)
static

Instanciate a ParametricCRS from a datum and a coordinate system.

Parameters
propertiesSee General properties. At minimum the name should be defined.
datumInthe datum.
csInthe coordinate system.
Returns
new ParametricCRS.
const datum::ParametricDatumNNPtr osgeo::proj::crs::ParametricCRS::datum ( ) const

Return the datum::ParametricDatum associated with the CRS.

Returns
a ParametricDatum
bool osgeo::proj::crs::ParametricCRS::isEquivalentTo ( const util::IComparable other,
util::IComparable::Criterion  criterion = util::IComparable::Criterion::STRICT 
) const
overridevirtual

Returns whether an object is equivalent to another one.

Parameters
otherother object to compare to
criterioncomparaison criterion.
Returns
true if objects are equivalent.

Reimplemented from osgeo::proj::common::ObjectUsage.


The documentation for this class was generated from the following files: