QGIS API Documentation  3.21.0-Master (5b68dc587e)
Classes | Static Public Member Functions | List of all members
QgsEllipsoidUtils Class Reference

Contains utility functions for working with ellipsoids and querying the ellipsoid database. More...

#include <qgsellipsoidutils.h>

Classes

struct  EllipsoidDefinition
 Contains definition of an ellipsoid. More...
 
struct  EllipsoidParameters
 Contains parameters for an ellipsoid. More...
 

Static Public Member Functions

static QStringList acronyms ()
 Returns a list of all known ellipsoid acronyms from the internal ellipsoid database. More...
 
static QList< QgsCelestialBodycelestialBodies ()
 Returns a list of all known celestial bodies. More...
 
static QList< QgsEllipsoidUtils::EllipsoidDefinitiondefinitions ()
 Returns a list of the definitions for all known ellipsoids from the internal ellipsoid database. More...
 
static EllipsoidParameters ellipsoidParameters (const QString &ellipsoid)
 Returns the parameters for the specified ellipsoid. More...
 
static void invalidateCache (bool disableCache=false)
 Clears the internal cache used. More...
 

Detailed Description

Contains utility functions for working with ellipsoids and querying the ellipsoid database.

Since
QGIS 3.0

Definition at line 33 of file qgsellipsoidutils.h.

Member Function Documentation

◆ acronyms()

QStringList QgsEllipsoidUtils::acronyms ( )
static

Returns a list of all known ellipsoid acronyms from the internal ellipsoid database.

See also
definitions()

Definition at line 329 of file qgsellipsoidutils.cpp.

◆ celestialBodies()

QList< QgsCelestialBody > QgsEllipsoidUtils::celestialBodies ( )
static

Returns a list of all known celestial bodies.

Note
This method is an alias for QgsCoordinateReferenceSystemRegistry::celestialBodies().
Warning
This method requires PROJ 8.1 or later
Exceptions
QgsNotSupportedExceptionon QGIS builds based on PROJ 8.0 or earlier.
Since
QGIS 3.20

Definition at line 341 of file qgsellipsoidutils.cpp.

◆ definitions()

QList< QgsEllipsoidUtils::EllipsoidDefinition > QgsEllipsoidUtils::definitions ( )
static

Returns a list of the definitions for all known ellipsoids from the internal ellipsoid database.

See also
acronyms()

Definition at line 241 of file qgsellipsoidutils.cpp.

◆ ellipsoidParameters()

QgsEllipsoidUtils::EllipsoidParameters QgsEllipsoidUtils::ellipsoidParameters ( const QString &  ellipsoid)
static

Returns the parameters for the specified ellipsoid.

Results are cached to allow for fast retrieval of parameters.

Definition at line 41 of file qgsellipsoidutils.cpp.

◆ invalidateCache()

void QgsEllipsoidUtils::invalidateCache ( bool  disableCache = false)
static

Clears the internal cache used.

If disableCache is true then the inbuilt cache will be completely disabled. This argument is for internal use only.

Since
QGIS 3.10

Definition at line 346 of file qgsellipsoidutils.cpp.


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