QGIS/python/core/auto_generated/proj/qgsellipsoidutils.sip.in
Nyall Dawson 3f6b490218 Sipify
2025-04-02 11:11:10 +10:00

98 lines
2.6 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/proj/qgsellipsoidutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsEllipsoidUtils
{
%Docstring(signature="appended")
Contains utility functions for working with ellipsoids and querying the
ellipsoid database.
%End
%TypeHeaderCode
#include "qgsellipsoidutils.h"
%End
public:
struct EllipsoidParameters
{
bool valid;
double semiMajor;
double semiMinor;
bool useCustomParameters;
double inverseFlattening;
QgsCoordinateReferenceSystem crs;
};
struct EllipsoidDefinition
{
QString acronym;
QString description;
QgsEllipsoidUtils::EllipsoidParameters parameters;
QString celestialBodyName;
};
static EllipsoidParameters ellipsoidParameters( const QString &ellipsoid );
%Docstring
Returns the parameters for the specified ``ellipsoid``. Results are
cached to allow for fast retrieval of parameters.
%End
static QList< QgsEllipsoidUtils::EllipsoidDefinition > definitions();
%Docstring
Returns a list of the definitions for all known ellipsoids from the
internal ellipsoid database.
.. seealso:: :py:func:`acronyms`
%End
static QStringList acronyms();
%Docstring
Returns a list of all known ellipsoid acronyms from the internal
ellipsoid database.
.. seealso:: :py:func:`definitions`
%End
static QList< QgsCelestialBody > celestialBodies();
%Docstring
Returns a list of all known celestial bodies.
.. note::
This method is an alias for :py:func:`QgsCoordinateReferenceSystemRegistry.celestialBodies()`.
.. warning::
This method requires PROJ 8.1 or later
:raises QgsNotSupportedException: on QGIS builds based on PROJ 8.0 or
earlier.
.. versionadded:: 3.20
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/proj/qgsellipsoidutils.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/