PROJ C++ API
Public Member Functions | Static Public Member Functions | List of all members
osgeo::proj::datum::DatumEnsemble Class Referencefinal

A collection of two or more geodetic or vertical reference frames (or if not geodetic or vertical reference frame, a collection of two or more datums) which for all but the highest accuracy requirements may be considered to be insignificantly different from each other. More...

#include <datum.hpp>

Inheritance diagram for osgeo::proj::datum::DatumEnsemble:
Inheritance graph
[legend]
Collaboration diagram for osgeo::proj::datum::DatumEnsemble:
Collaboration graph
[legend]

Public Member Functions

const std::vector< DatumNNPtr > & datums () const
 Return the set of datums which may be considered to be insignificantly different from each other. More...
 
const metadata::PositionalAccuracyNNPtrpositionalAccuracy () const
 Return the inaccuracy introduced through use of this collection of datums. More...
 
- 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::util::IComparable
virtual bool isEquivalentTo (const IComparable *other, Criterion criterion=Criterion::STRICT) const =0
 Returns whether an object is equivalent to another one. More...
 
- Public Member Functions inherited from osgeo::proj::io::IWKTExportable
std::string exportToWKT (WKTFormatter *formatter) const
 

Static Public Member Functions

static DatumEnsembleNNPtr create (const util::PropertyMap &properties, const std::vector< DatumNNPtr > &datumsIn, const metadata::PositionalAccuracyNNPtr &accuracy)
 Instanciate a DatumEnsemble. 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::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

A collection of two or more geodetic or vertical reference frames (or if not geodetic or vertical reference frame, a collection of two or more datums) which for all but the highest accuracy requirements may be considered to be insignificantly different from each other.

Every frame within the datum ensemble must be a realizations of the same Terrestrial Reference System or Vertical Reference System.

Remarks
Implements DatumEnsemble from ISO 19111:2018

Member Function Documentation

DatumEnsembleNNPtr osgeo::proj::datum::DatumEnsemble::create ( const util::PropertyMap properties,
const std::vector< DatumNNPtr > &  datumsIn,
const metadata::PositionalAccuracyNNPtr accuracy 
)
static

Instanciate a DatumEnsemble.

Parameters
propertiesSee General properties. At minimum the name should be defined.
datumsInArray of at least 2 datums.
accuracyAccuracy of the datum ensemble
Returns
new DatumEnsemble.
Exceptions
util::Exception
const std::vector< DatumNNPtr > & osgeo::proj::datum::DatumEnsemble::datums ( ) const

Return the set of datums which may be considered to be insignificantly different from each other.

Returns
the set of datums of the DatumEnsemble.
const metadata::PositionalAccuracyNNPtr & osgeo::proj::datum::DatumEnsemble::positionalAccuracy ( ) const

Return the inaccuracy introduced through use of this collection of datums.

It is an indication of the differences in coordinate values at all points between the various realizations that have been grouped into this datum ensemble.

Returns
the accuracy.

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