The definition of a coordinate system axis. More...

#include <coordinatesystem.hpp>

Inheritance diagram for osgeo::proj::cs::CoordinateSystemAxis:

[legend]

Collaboration diagram for osgeo::proj::cs::CoordinateSystemAxis:

[legend]

Public Member Functions
const std::string &	abbreviation () PROJ_CONST_DECL
	Return the axis abbreviation. More...

const AxisDirection &	direction () PROJ_CONST_DECL
	Return the axis direction. More...

const common::UnitOfMeasure &	unit () PROJ_CONST_DECL
	Return the axis unit. More...

const util::optional< double > &	minimumValue () PROJ_CONST_DECL
	Return the minimum value normally allowed for this axis, in the unit for the axis. More...

const util::optional< double > &	maximumValue () PROJ_CONST_DECL
	Return the maximum value normally allowed for this axis, in the unit for the axis. More...

const MeridianPtr &	meridian () PROJ_CONST_DECL
	Return the meridian that the axis follows from the pole, for a coordinate reference system centered on a pole. 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 Member Functions
static CoordinateSystemAxisNNPtr	create (const util::PropertyMap &properties, const std::string &abbreviationIn, const AxisDirection &directionIn, const common::UnitOfMeasure &unitIn, const MeridianPtr &meridianIn=nullptr)
	Instanciate a CoordinateSystemAxis. 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

The definition of a coordinate system axis.

Remarks: Implements CoordinateSystemAxis from ISO 19111:2018

Member Function Documentation

const std::string & osgeo::proj::cs::CoordinateSystemAxis::abbreviation ( )

Return the axis abbreviation.

The abbreviation used for this coordinate system axis; this abbreviation is also used to identify the coordinates in the coordinate tuple. Examples are X and Y.

Returns: the abbreviation.

CoordinateSystemAxisNNPtr osgeo::proj::cs::CoordinateSystemAxis::create	(	const util::PropertyMap &	properties,
		const std::string &	abbreviationIn,
		const AxisDirection &	directionIn,
		const common::UnitOfMeasure &	unitIn,
		const MeridianPtr &	meridianIn = `nullptr`
	)

static

Instanciate a CoordinateSystemAxis.

Parameters

properties	See General properties. The name should generally be defined.
abbreviationIn	Axis abbreviation (might be empty)
directionIn	Axis direction
unitIn	Axis unit
meridianIn	The meridian that the axis follows from the pole, for a coordinate reference system centered on a pole, or nullptr

Returns: a new CoordinateSystemAxis.

const AxisDirection & osgeo::proj::cs::CoordinateSystemAxis::direction ( )

Return the axis direction.

The direction of this coordinate system axis (or in the case of Cartesian projected coordinates, the direction of this coordinate system axis locally) Examples: north or south, east or west, up or down. Within any set of coordinate system axes, only one of each pair of terms can be used. For Earth-fixed CRSs, this direction is often approximate and intended to provide a human interpretable meaning to the axis. When a geodetic reference frame is used, the precise directions of the axes may therefore vary slightly from this approximate direction. Note that an EngineeringCRS often requires specific descriptions of the directions of its coordinate system axes.

Returns: the direction.

bool osgeo::proj::cs::CoordinateSystemAxis::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.

Implements osgeo::proj::util::IComparable.

const util::optional< double > & osgeo::proj::cs::CoordinateSystemAxis::maximumValue ( )

Return the maximum value normally allowed for this axis, in the unit for the axis.

Returns: the maximum value, or empty.

const MeridianPtr & osgeo::proj::cs::CoordinateSystemAxis::meridian ( )

Return the meridian that the axis follows from the pole, for a coordinate reference system centered on a pole.

Returns: the meridian, or null.

const util::optional< double > & osgeo::proj::cs::CoordinateSystemAxis::minimumValue ( )

Return the minimum value normally allowed for this axis, in the unit for the axis.

Returns: the minimum value, or empty.

const common::UnitOfMeasure & osgeo::proj::cs::CoordinateSystemAxis::unit ( )

Return the axis unit.

This is the spatial unit or temporal quantity used for this coordinate system axis. The value of a coordinate in a coordinate tuple shall be recorded using this unit.

Returns: the axis unit.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation