Add QgsCoordinateReferenceSystemRegistry::celestialBodies() for

retrieving a list of all known celestial bodies from PROJ Requires PROJ 8.1+
qgis · May 10, 2021 · 7604b6e · 7604b6e
1 parent 7e1f9d7
commit 7604b6e
Show file tree

Hide file tree

Showing 9 changed files with 133 additions and 0 deletions.
diff --git a/python/core/auto_generated/proj/qgscoordinatereferencesystemregistry.sip.in b/python/core/auto_generated/proj/qgscoordinatereferencesystemregistry.sip.in
@@ -9,6 +9,7 @@
 
 
 
+
 class QgsCoordinateReferenceSystemRegistry : QObject
 {
 %Docstring(signature="appended")
@@ -31,6 +32,8 @@ any user-defined CRSes.
 Constructor for QgsCoordinateReferenceSystemRegistry, with the specified ``parent`` object.
 %End
 
+    ~QgsCoordinateReferenceSystemRegistry();
+
     class UserCrsDetails
 {
 %Docstring(signature="appended")
@@ -108,6 +111,20 @@ Removes the existing user CRS with matching ``id``.
 Returns ``False`` if the CRS could not be removed.
 
 .. seealso:: :py:func:`userCrsRemoved`
+%End
+
+    QList< QgsCelestialBody > celestialBodies() const;
+%Docstring
+Returns a list of all known celestial bodies.
+
+.. warning::
+
+   This method requires PROJ 8.1 or later
+
+:raises :: py:class:`QgsNotSupportedException` on QGIS builds based on PROJ 8.0 or earlier.
+
+
+.. versionadded:: 3.20
 %End
 
   signals:

diff --git a/python/core/auto_generated/proj/qgsellipsoidutils.sip.in b/python/core/auto_generated/proj/qgsellipsoidutils.sip.in
@@ -8,6 +8,7 @@
 
 
 
+
 class QgsEllipsoidUtils
 {
 %Docstring(signature="appended")
@@ -33,6 +34,7 @@ Contains utility functions for working with ellipsoids and querying the ellipsoi
       double inverseFlattening;
 
       QgsCoordinateReferenceSystem crs;
+
     };
 
     struct EllipsoidDefinition
@@ -64,6 +66,25 @@ 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 :: py:class:`QgsNotSupportedException` on QGIS builds based on PROJ 8.0 or earlier.
+
+
+.. versionadded:: 3.20
 %End
 
 };

diff --git a/python/core/core_auto.sip b/python/core/core_auto.sip
@@ -428,6 +428,7 @@
 %Include auto_generated/pointcloud/qgspointcloudrenderer.sip
 %Include auto_generated/pointcloud/qgspointcloudrendererregistry.sip
 %Include auto_generated/pointcloud/qgspointcloudrgbrenderer.sip
+%Include auto_generated/proj/qgscelestialbody.sip
 %Include auto_generated/proj/qgscoordinatereferencesystem.sip
 %Include auto_generated/proj/qgscoordinatereferencesystemregistry.sip
 %Include auto_generated/proj/qgscoordinatetransform.sip

diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -1357,6 +1357,7 @@ set(QGIS_CORE_HDRS
   pointcloud/qgspointcloudrendererregistry.h
   pointcloud/qgspointcloudrgbrenderer.h
 
+  proj/qgscelestialbody.h
   proj/qgscoordinatereferencesystem.h
   proj/qgscoordinatereferencesystemregistry.h
   proj/qgscoordinatetransform.h

diff --git a/src/core/proj/qgscoordinatereferencesystemregistry.cpp b/src/core/proj/qgscoordinatereferencesystemregistry.cpp
@@ -22,15 +22,23 @@
 #include "qgslogger.h"
 #include "qgsmessagelog.h"
 #include "qgssqliteutils.h"
+#include "qgscelestialbody.h"
+#include "qgsprojutils.h"
+#include "qgsruntimeprofiler.h"
+#include "qgsexception.h"
 
 #include <sqlite3.h>
+#include <mutex>
+#include <proj.h>
 
 QgsCoordinateReferenceSystemRegistry::QgsCoordinateReferenceSystemRegistry( QObject *parent )
   : QObject( parent )
 {
 
 }
 
+QgsCoordinateReferenceSystemRegistry::~QgsCoordinateReferenceSystemRegistry() = default;
+
 QList<QgsCoordinateReferenceSystemRegistry::UserCrsDetails> QgsCoordinateReferenceSystemRegistry::userCrsList() const
 {
   QList<QgsCoordinateReferenceSystemRegistry::UserCrsDetails> res;
@@ -335,3 +343,39 @@ bool QgsCoordinateReferenceSystemRegistry::insertProjection( const QString &proj
 
   return true;
 }
+
+QList< QgsCelestialBody> QgsCoordinateReferenceSystemRegistry::celestialBodies() const
+{
+#if PROJ_VERSION_MAJOR>8 || (PROJ_VERSION_MAJOR==8 && PROJ_VERSION_MINOR>=1)
+
+  static std::once_flag initialized;
+  std::call_once( initialized, [ = ]
+  {
+    QgsScopedRuntimeProfile profile( QObject::tr( "Initialize celestial bodies" ) );
+
+    PJ_CONTEXT *context = QgsProjContext::get();
+
+    int resultCount = 0;
+    PROJ_CELESTIAL_BODY_INFO **list = proj_get_celestial_body_list_from_database( context, nullptr, &resultCount );
+    mCelestialBodies.reserve( resultCount );
+    for ( int i = 0; i < resultCount; i++ )
+    {
+      const PROJ_CELESTIAL_BODY_INFO *info = list[ i ];
+      if ( !info )
+        break;
+
+      QgsCelestialBody body;
+      body.mValid = true;
+      body.mAuthority = QString( info->auth_name );
+      body.mName = QString( info->name );
+
+      mCelestialBodies << body;
+    }
+    proj_celestial_body_list_destroy( list );
+  } );
+
+  return mCelestialBodies;
+#else
+  throw QgsNotSupportedException( QStringLiteral( "Retrieving celestial bodies requires a QGIS build based on PROJ 8.1 or later" ) );
+#endif
+}
diff --git a/src/core/proj/qgscoordinatereferencesystemregistry.h b/src/core/proj/qgscoordinatereferencesystemregistry.h
@@ -21,6 +21,8 @@
 #include <QObject>
 #include "qgscoordinatereferencesystem.h"
 
+class QgsCelestialBody;
+
 /**
  * \class QgsCoordinateReferenceSystemRegistry
  * \ingroup core
@@ -42,6 +44,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystemRegistry : public QObject
      */
     explicit QgsCoordinateReferenceSystemRegistry( QObject *parent = nullptr );
 
+    ~QgsCoordinateReferenceSystemRegistry();
+
     /**
      * \brief Contains details of a custom (user defined) CRS.
      * \ingroup core
@@ -119,6 +123,17 @@ class CORE_EXPORT QgsCoordinateReferenceSystemRegistry : public QObject
      */
     bool removeUserCrs( long id );
 
+    /**
+     * Returns a list of all known celestial bodies.
+     *
+     * \warning This method requires PROJ 8.1 or later
+     *
+     * \throws QgsNotSupportedException on QGIS builds based on PROJ 8.0 or earlier.
+     *
+     * \since QGIS 3.20
+     */
+    QList< QgsCelestialBody > celestialBodies() const;
+
   signals:
 
     /**
@@ -163,6 +178,8 @@ class CORE_EXPORT QgsCoordinateReferenceSystemRegistry : public QObject
 
     bool insertProjection( const QString &projectionAcronym );
 
+    mutable QList< QgsCelestialBody > mCelestialBodies;
+
 };
 
 

diff --git a/src/core/proj/qgsellipsoidutils.cpp b/src/core/proj/qgsellipsoidutils.cpp
@@ -22,6 +22,8 @@
 #include "qgsprojutils.h"
 #include "qgsreadwritelocker.h"
 #include "qgsruntimeprofiler.h"
+#include "qgscoordinatereferencesystemregistry.h"
+#include "qgscelestialbody.h"
 
 #include <proj.h>
 #include <mutex>
@@ -336,6 +338,11 @@ QStringList QgsEllipsoidUtils::acronyms()
   return result;
 }
 
+QList<QgsCelestialBody> QgsEllipsoidUtils::celestialBodies()
+{
+  return QgsApplication::coordinateReferenceSystemRegistry()->celestialBodies();
+}
+
 void QgsEllipsoidUtils::invalidateCache( bool disableCache )
 {
   QgsReadWriteLocker locker1( *sEllipsoidCacheLock(), QgsReadWriteLocker::Write );

diff --git a/src/core/proj/qgsellipsoidutils.h b/src/core/proj/qgsellipsoidutils.h
@@ -21,6 +21,8 @@
 #include "qgscoordinatereferencesystem.h"
 #include <QStringList>
 
+class QgsCelestialBody;
+
 /**
  * \class QgsEllipsoidUtils
  * \ingroup core
@@ -54,6 +56,7 @@ class CORE_EXPORT QgsEllipsoidUtils
 
       //! Associated coordinate reference system
       QgsCoordinateReferenceSystem crs;
+
     };
 
     /**
@@ -99,6 +102,19 @@ class CORE_EXPORT QgsEllipsoidUtils
      */
     static QStringList acronyms();
 
+    /**
+     * 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
+     *
+     * \throws QgsNotSupportedException on QGIS builds based on PROJ 8.0 or earlier.
+     *
+     * \since QGIS 3.20
+     */
+    static QList< QgsCelestialBody > celestialBodies();
+
 #ifndef SIP_RUN
 
     /**

diff --git a/tests/src/python/test_qgsellipsoidutils.py b/tests/src/python/test_qgsellipsoidutils.py
@@ -112,6 +112,15 @@ def testDefinitions(self):
         self.assertFalse(gany_defs.parameters.useCustomParameters)
         self.assertEqual(gany_defs.parameters.crs.authid(), '')
 
+    @unittest.skipIf(QgsProjUtils.projVersionMajor() < 8 or (QgsProjUtils.projVersionMajor() == 8 and QgsProjUtils.projVersionMinor() < 1), 'Not a proj >= 8.1 build')
+    def testCelestialBodies(self):
+        bodies = QgsEllipsoidUtils.celestialBodies()
+
+        self.assertTrue(bodies)
+
+        ganymede = [body for body in bodies if body.name() == 'Ganymede' and body.authority() == 'ESRI'][0]
+        self.assertTrue(ganymede.isValid())
+
     def testMappingEllipsoidsToProj6(self):
         old_qgis_ellipsoids = {'Adrastea2000': 'Adrastea2000', 'airy': 'Airy 1830', 'Amalthea2000': 'Amalthea2000',
                                'Ananke2000': 'Ananke2000',