PROJ C++ API
Public Types | Public Member Functions | Static Public Member Functions | List of all members
osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits > Class Template Referencefinal

Template representing a derived coordinate reference system. More...

#include <crs.hpp>

Inheritance diagram for osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >:
Inheritance graph
[legend]
Collaboration diagram for osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >:
Collaboration graph
[legend]

Public Types

typedef util::nn< std::shared_ptr< DerivedCRSTemplate > > NNPtr
 
typedef util::nn< std::shared_ptr< BaseType > > BaseNNPtr
 
typedef util::nn< std::shared_ptr< CSType > > CSNNPtr
 
- Public Types inherited from osgeo::proj::util::IComparable
enum  Criterion { Criterion::STRICT, Criterion::EQUIVALENT }
 Comparison criterion. More...
 

Public Member Functions

const BaseNNPtr baseCRS () const
 Return the base CRS of a DerivedCRSTemplate. More...
 
- Public Member Functions inherited from osgeo::proj::crs::DerivedCRS
const SingleCRSNNPtrbaseCRS () PROJ_CONST_DECL
 Return the base CRS of a DerivedCRS. More...
 
const operation::ConversionNNPtr derivingConversion () const
 Return the deriving conversion from the base CRS to this 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...
 
- 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...
 
virtual CRSNNPtr shallowClone () const =0
 Return a shallow clone of this object.
 
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 NNPtr create (const util::PropertyMap &properties, const BaseNNPtr &baseCRSIn, const operation::ConversionNNPtr &derivingConversionIn, const CSNNPtr &csIn)
 Instanciate a DerivedCRSTemplate from a base CRS, a deriving conversion and a cs::CoordinateSystem. 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

- 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

template<class DerivedCRSTraits>
class osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >

Template representing a derived coordinate reference system.

Member Typedef Documentation

template<class DerivedCRSTraits>
typedef util::nn<std::shared_ptr<BaseType> > osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >::BaseNNPtr

Non-null shared pointer of BaseType

template<class DerivedCRSTraits>
typedef util::nn<std::shared_ptr<CSType> > osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >::CSNNPtr

Non-null shared pointer of CSType

template<class DerivedCRSTraits>
typedef util::nn<std::shared_ptr<DerivedCRSTemplate> > osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >::NNPtr

Non-null shared pointer of DerivedCRSTemplate

Member Function Documentation

template<class DerivedCRSTraits >
const DerivedCRSTemplate< DerivedCRSTraits >::BaseNNPtr osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >::baseCRS ( ) const

Return the base CRS of a DerivedCRSTemplate.

Returns
the base CRS.
template<class DerivedCRSTraits>
static NNPtr osgeo::proj::crs::DerivedCRSTemplate< DerivedCRSTraits >::create ( const util::PropertyMap properties,
const BaseNNPtr baseCRSIn,
const operation::ConversionNNPtr derivingConversionIn,
const CSNNPtr csIn 
)
static

Instanciate a DerivedCRSTemplate from a base CRS, a deriving conversion and a cs::CoordinateSystem.

Parameters
propertiesSee General properties. At minimum the name should be defined.
baseCRSInbase CRS.
derivingConversionInthe deriving conversion from the base CRS to this CRS.
csInthe coordinate system.
Returns
new DerivedCRSTemplate.

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