osgeo::proj::cs::VerticalCS Class Reference

A one-dimensional coordinate system used to record the heights or depths of points. More...

#include <coordinatesystem.hpp>

Inheritance diagram for osgeo::proj::cs::VerticalCS:

Collaboration diagram for osgeo::proj::cs::VerticalCS:

Static Public Member Functions
static VerticalCSNNPtr	create (const util::PropertyMap &properties, const CoordinateSystemAxisNNPtr &axis)
	Instanciate a VerticalCS. More...
static VerticalCSNNPtr	createGravityRelatedHeight (const common::UnitOfMeasure &unit)
	Instanciate a VerticalCS with a Gravity-related height axis. 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...
Public Member Functions inherited from osgeo::proj::cs::CoordinateSystem
const std::vector< CoordinateSystemAxisNNPtr > &	axisList () PROJ_CONST_DECL
	Return the list of axes of this coordinate system. 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::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
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 one-dimensional coordinate system used to record the heights or depths of points.

Such a coordinate system is usually dependent on the Earth's gravity field. A VerticalCS shall have one axis association.

Remarks

Implements VerticalCS from ISO 19111:2018

Member Function Documentation

VerticalCSNNPtr osgeo::proj::cs::VerticalCS::create ( const util::PropertyMap &  properties, const CoordinateSystemAxisNNPtr &  axis  )

static

Instanciate a VerticalCS.

Parameters

properties	See General properties.
axis	The axis.

Returns

a new VerticalCS.

VerticalCSNNPtr osgeo::proj::cs::VerticalCS::createGravityRelatedHeight ( const common::UnitOfMeasure &  unit )

static

Instanciate a VerticalCS with a Gravity-related height axis.

Parameters

unit	linear unit.

Returns

a new VerticalCS.

---

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

• include/proj/coordinatesystem.hpp
• src/coordinatesystem.cpp