A coordinate reference system having a vertical reference frame and a one-dimensional vertical coordinate system used for recording gravity-related heights or depths. More...

#include <crs.hpp>

Inheritance diagram for osgeo::proj::crs::VerticalCRS:

[legend]

Collaboration diagram for osgeo::proj::crs::VerticalCRS:

[legend]

Public Member Functions
const datum::VerticalReferenceFramePtr	datum () const
	Return the datum::VerticalReferenceFrame associated with the CRS. More...

const cs::VerticalCSNNPtr	coordinateSystem () const
	Return the cs::VerticalCS associated with the CRS. More...

const std::vector< operation::TransformationNNPtr > &	geoidModel () PROJ_CONST_DECL
	Return the geoid model associated with the CRS. More...

const std::vector< operation::PointMotionOperationNNPtr > &	velocityModel () PROJ_CONST_DECL
	Return the velocity model 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::DatumPtr &	datum () PROJ_CONST_DECL
	Return the datum::Datum associated with the CRS. More...

const datum::DatumEnsemblePtr &	datumEnsemble () PROJ_CONST_DECL
	Return the datum::DatumEnsemble associated with the CRS. More...

const cs::CoordinateSystemNNPtr &	coordinateSystem () 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 BoundCRSPtr &	canonicalBoundCRS () 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::IdentifierNNPtr &	name () 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

Public Member Functions inherited from osgeo::proj::io::IPROJStringExportable
std::string	exportToPROJString (PROJStringFormatter *formatter) const
	Builds a PROJ string representation. More...

Static Public Member Functions
static VerticalCRSNNPtr	create (const util::PropertyMap &properties, const datum::VerticalReferenceFrameNNPtr &datumIn, const cs::VerticalCSNNPtr &csIn)
	Instanciate a VerticalCRS from a datum::VerticalReferenceFrame and a cs::VerticalCS. More...

static VerticalCRSNNPtr	create (const util::PropertyMap &properties, const datum::VerticalReferenceFramePtr &datumIn, const datum::DatumEnsemblePtr &datumEnsembleIn, const cs::VerticalCSNNPtr &csIn)
	Instanciate a VerticalCRS from a datum::VerticalReferenceFrame or datum::DatumEnsemble and a cs::VerticalCS. 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

A coordinate reference system having a vertical reference frame and a one-dimensional vertical coordinate system used for recording gravity-related heights or depths.

Vertical CRSs make use of the direction of gravity to define the concept of height or depth, but the relationship with gravity may not be straightforward. If the vertical reference frame is dynamic or if the vertical CRS has an association to a velocity model then the CRS is dynamic, else it is static.

Note: Ellipsoidal heights cannot be captured in a vertical coordinate reference system. They exist only as an inseparable part of a 3D coordinate tuple defined in a geographic 3D coordinate reference system.

Remarks: Implements VerticalCRS from ISO 19111:2018

Member Function Documentation

const cs::VerticalCSNNPtr osgeo::proj::crs::VerticalCRS::coordinateSystem ( ) const

Return the cs::VerticalCS associated with the CRS.

Returns: a VerticalCS.

VerticalCRSNNPtr osgeo::proj::crs::VerticalCRS::create	(	const util::PropertyMap &	properties,
		const datum::VerticalReferenceFrameNNPtr &	datumIn,
		const cs::VerticalCSNNPtr &	csIn
	)

static

Instanciate a VerticalCRS from a datum::VerticalReferenceFrame and a cs::VerticalCS.

Parameters

properties	See General properties. At minimum the name should be defined.
datumIn	The datum of the CRS.
csIn	a VerticalCS.

Returns: new VerticalCRS.

VerticalCRSNNPtr osgeo::proj::crs::VerticalCRS::create	(	const util::PropertyMap &	properties,
		const datum::VerticalReferenceFramePtr &	datumIn,
		const datum::DatumEnsemblePtr &	datumEnsembleIn,
		const cs::VerticalCSNNPtr &	csIn
	)

static

Instanciate a VerticalCRS from a datum::VerticalReferenceFrame or datum::DatumEnsemble and a cs::VerticalCS.

One and only one of datum or datumEnsemble should be set to a non-null value.

Parameters

properties	See General properties. At minimum the name should be defined.
datumIn	The datum of the CRS, or nullptr
datumEnsembleIn	The datum ensemble of the CRS, or nullptr.
csIn	a VerticalCS.

Returns: new VerticalCRS.

const datum::VerticalReferenceFramePtr osgeo::proj::crs::VerticalCRS::datum ( ) const

Return the datum::VerticalReferenceFrame associated with the CRS.

Returns: a VerticalReferenceFrame.

const std::vector< operation::TransformationNNPtr > & osgeo::proj::crs::VerticalCRS::geoidModel ( )

Return the geoid model associated with the CRS.

Geoid height model or height correction model linked to a geoid-based vertical CRS.

Returns: a geoid model. might be null

bool osgeo::proj::crs::VerticalCRS::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

other	other object to compare to
criterion	comparaison criterion.

Returns: true if objects are equivalent.

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

Reimplemented in osgeo::proj::crs::DerivedVerticalCRS.

const std::vector< operation::PointMotionOperationNNPtr > & osgeo::proj::crs::VerticalCRS::velocityModel ( )

Return the velocity model associated with the CRS.

Returns: a velocity model. might be null.

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

include/proj/crs.hpp
src/crs.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation