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

A geodetic reference frame in which some of the parameters describe time evolution of defining station coordinates. More...

#include <datum.hpp>

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

Public Member Functions

const common::MeasureframeReferenceEpoch () const
 Return the epoch to which the coordinates of stations defining the dynamic geodetic reference frame are referenced. More...
 
const util::optional< std::string > & deformationModelName () const
 Return the name of the deformation model. 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::datum::GeodeticReferenceFrame
const PrimeMeridianNNPtrprimeMeridian () PROJ_CONST_DECL
 Return the PrimeMeridian associated with a GeodeticReferenceFrame. More...
 
const EllipsoidNNPtrellipsoid () PROJ_CONST_DECL
 Return the Ellipsoid associated with a GeodeticReferenceFrame. More...
 
- Public Member Functions inherited from osgeo::proj::datum::Datum
const util::optional< std::string > & anchorDefinition () const
 Return the anchor definition. More...
 
const util::optional< common::DateTime > & publicationDate () const
 Return the date on which the datum definition was published. More...
 
const common::IdentifiedObjectPtrconventionalRS () const
 Return the conventional reference system. 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 DynamicGeodeticReferenceFrameNNPtr create (const util::PropertyMap &properties, const EllipsoidNNPtr &ellipsoid, const util::optional< std::string > &anchor, const PrimeMeridianNNPtr &primeMeridian, const common::Measure &frameReferenceEpochIn, const util::optional< std::string > &deformationModelNameIn)
 Instanciate a DyanmicGeodeticReferenceFrame. More...
 
- Static Public Member Functions inherited from osgeo::proj::datum::GeodeticReferenceFrame
static GeodeticReferenceFrameNNPtr create (const util::PropertyMap &properties, const EllipsoidNNPtr &ellipsoid, const util::optional< std::string > &anchor, const PrimeMeridianNNPtr &primeMeridian)
 Instanciate a GeodeticReferenceFrame. 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::datum::GeodeticReferenceFrame
static const GeodeticReferenceFrameNNPtr EPSG_6267
 The EPSG:6267 / "North_American_Datum_1927" GeodeticReferenceFrame.
 
static const GeodeticReferenceFrameNNPtr EPSG_6269
 The EPSG:6269 / "North_American_Datum_1983" GeodeticReferenceFrame.
 
static const GeodeticReferenceFrameNNPtr EPSG_6326
 The EPSG:6326 / "WGS_1984" GeodeticReferenceFrame.
 
- 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

A geodetic reference frame in which some of the parameters describe time evolution of defining station coordinates.

For example defining station coordinates having linear velocities to account for crustal motion.

Remarks
Implements DynamicGeodeticReferenceFrame from ISO 19111:2018

Member Function Documentation

DynamicGeodeticReferenceFrameNNPtr osgeo::proj::datum::DynamicGeodeticReferenceFrame::create ( const util::PropertyMap properties,
const EllipsoidNNPtr ellipsoid,
const util::optional< std::string > &  anchor,
const PrimeMeridianNNPtr primeMeridian,
const common::Measure frameReferenceEpochIn,
const util::optional< std::string > &  deformationModelNameIn 
)
static

Instanciate a DyanmicGeodeticReferenceFrame.

Parameters
propertiesSee General properties. At minimum the name should be defined.
ellipsoidthe Ellipsoid.
anchorthe anchor definition, or empty.
primeMeridianthe PrimeMeridian.
frameReferenceEpochInthe frame reference epoch.
deformationModelNameIndeformation model name, or empty
Returns
new DyanmicGeodeticReferenceFrame.
const util::optional< std::string > & osgeo::proj::datum::DynamicGeodeticReferenceFrame::deformationModelName ( ) const

Return the name of the deformation model.

Note
This is an extension to the ISO 19111:2018 modeling, to hold the content of the DYNAMIC.MODEL WKT2 node.
Returns
the name of the deformation model.
const common::Measure & osgeo::proj::datum::DynamicGeodeticReferenceFrame::frameReferenceEpoch ( ) const

Return the epoch to which the coordinates of stations defining the dynamic geodetic reference frame are referenced.

Usually given as a decimal year e.g. 2016.47.

Returns
the frame reference epoch.
bool osgeo::proj::datum::DynamicGeodeticReferenceFrame::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::datum::GeodeticReferenceFrame.


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