PROJ C++ API
Public Types | Public Member Functions | Static Public Member Functions | List of all members
osgeo::proj::cs::EllipsoidalCS Class Referencefinal

A two- or three-dimensional coordinate system in which position is specified by geodetic latitude, geodetic longitude, and (in the three-dimensional case) ellipsoidal height. More...

#include <coordinatesystem.hpp>

Inheritance diagram for osgeo::proj::cs::EllipsoidalCS:
Inheritance graph
[legend]
Collaboration diagram for osgeo::proj::cs::EllipsoidalCS:
Collaboration graph
[legend]

Public Types

enum  AxisOrder {
  AxisOrder::LAT_NORTH_LONG_EAST, AxisOrder::LAT_NORTH_LONG_EAST_HEIGHT_UP, AxisOrder::LONG_EAST_LAT_NORTH, AxisOrder::LONG_EAST_LAT_NORTH_HEIGHT_UP,
  AxisOrder::OTHER
}
 Typical axis order. More...
 
- Public Types inherited from osgeo::proj::util::IComparable
enum  Criterion { Criterion::STRICT, Criterion::EQUIVALENT }
 Comparison criterion. More...
 

Public Member Functions

AxisOrder axisOrder () const
 Return the axis order in an enumerated way.
 
- 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::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 EllipsoidalCSNNPtr create (const util::PropertyMap &properties, const CoordinateSystemAxisNNPtr &axis1, const CoordinateSystemAxisNNPtr &axis2)
 Instanciate a EllipsoidalCS. More...
 
static EllipsoidalCSNNPtr create (const util::PropertyMap &properties, const CoordinateSystemAxisNNPtr &axis1, const CoordinateSystemAxisNNPtr &axis2, const CoordinateSystemAxisNNPtr &axis3)
 Instanciate a EllipsoidalCS. More...
 
static EllipsoidalCSNNPtr createLatitudeLongitude (const common::UnitOfMeasure &unit)
 Instanciate a EllipsoidalCS with a Latitude (first) and Longitude (second) axis. More...
 
static EllipsoidalCSNNPtr createLatitudeLongitudeEllipsoidalHeight (const common::UnitOfMeasure &angularUnit, const common::UnitOfMeasure &linearUnit)
 Instanciate a EllipsoidalCS with a Latitude (first), Longitude (second) axis and ellipsoidal height (third) axis. More...
 
static EllipsoidalCSNNPtr createLongitudeLatitude (const common::UnitOfMeasure &unit)
 Instanciate a EllipsoidalCS with a Longitude (first) and Latitude (second) 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

- 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 two- or three-dimensional coordinate system in which position is specified by geodetic latitude, geodetic longitude, and (in the three-dimensional case) ellipsoidal height.

An EllipsoidalCS shall have two or three associations.

Remarks
Implements EllipsoidalCS from ISO 19111:2018

Member Enumeration Documentation

Typical axis order.

Enumerator
LAT_NORTH_LONG_EAST 

Latitude(North), Longitude(East)

LAT_NORTH_LONG_EAST_HEIGHT_UP 

Latitude(North), Longitude(East), Height(up)

LONG_EAST_LAT_NORTH 

Longitude(East), Latitude(North)

LONG_EAST_LAT_NORTH_HEIGHT_UP 

Longitude(East), Latitude(North), Height(up)

OTHER 

Other axis order.

Member Function Documentation

EllipsoidalCSNNPtr osgeo::proj::cs::EllipsoidalCS::create ( const util::PropertyMap properties,
const CoordinateSystemAxisNNPtr axis1,
const CoordinateSystemAxisNNPtr axis2 
)
static

Instanciate a EllipsoidalCS.

Parameters
propertiesSee General properties.
axis1The first axis.
axis2The second axis.
Returns
a new EllipsoidalCS.
EllipsoidalCSNNPtr osgeo::proj::cs::EllipsoidalCS::create ( const util::PropertyMap properties,
const CoordinateSystemAxisNNPtr axis1,
const CoordinateSystemAxisNNPtr axis2,
const CoordinateSystemAxisNNPtr axis3 
)
static

Instanciate a EllipsoidalCS.

Parameters
propertiesSee General properties.
axis1The first axis.
axis2The second axis.
axis3The third axis.
Returns
a new EllipsoidalCS.
EllipsoidalCSNNPtr osgeo::proj::cs::EllipsoidalCS::createLatitudeLongitude ( const common::UnitOfMeasure unit)
static

Instanciate a EllipsoidalCS with a Latitude (first) and Longitude (second) axis.

Parameters
unitAngular unit of the axes.
Returns
a new EllipsoidalCS.
EllipsoidalCSNNPtr osgeo::proj::cs::EllipsoidalCS::createLatitudeLongitudeEllipsoidalHeight ( const common::UnitOfMeasure angularUnit,
const common::UnitOfMeasure linearUnit 
)
static

Instanciate a EllipsoidalCS with a Latitude (first), Longitude (second) axis and ellipsoidal height (third) axis.

Parameters
angularUnitAngular unit of the latitude and longitude axes.
linearUnitLinear unit of the ellipsoidal height axis.
Returns
a new EllipsoidalCS.
EllipsoidalCSNNPtr osgeo::proj::cs::EllipsoidalCS::createLongitudeLatitude ( const common::UnitOfMeasure unit)
static

Instanciate a EllipsoidalCS with a Longitude (first) and Latitude (second) axis.

Parameters
unitAngular unit of the axes.
Returns
a new EllipsoidalCS.

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