Branch data     Line data    Source code

       1                 :            : /***************************************************************************
       2                 :            :   qgsellipsoidutils.h
       3                 :            :  --------------------
       4                 :            :   Date                 : April 2017
       5                 :            :   Copyright            : (C) 2017 by Nyall Dawson
       6                 :            :   email                : nyall dot dawson at gmail dot com
       7                 :            :  ***************************************************************************
       8                 :            :  *                                                                         *
       9                 :            :  *   This program is free software; you can redistribute it and/or modify  *
      10                 :            :  *   it under the terms of the GNU General Public License as published by  *
      11                 :            :  *   the Free Software Foundation; either version 2 of the License, or     *
      12                 :            :  *   (at your option) any later version.                                   *
      13                 :            :  *                                                                         *
      14                 :            :  ***************************************************************************/
      15                 :            : 
      16                 :            : #ifndef QGSELLIPSOIDUTILS_H
      17                 :            : #define QGSELLIPSOIDUTILS_H
      18                 :            : 
      19                 :            : #include "qgis_core.h"
      20                 :            : #include "qgis_sip.h"
      21                 :            : #include "qgscoordinatereferencesystem.h"
      22                 :            : #include <QStringList>
      23                 :            : 
      24                 :            : /**
      25                 :            :  * \class QgsEllipsoidUtils
      26                 :            :  * \ingroup core
      27                 :            :  * \brief Contains utility functions for working with ellipsoids and querying the ellipsoid database.
      28                 :            :  *
      29                 :            :  * \since QGIS 3.0
      30                 :            : */
      31                 :            : class CORE_EXPORT QgsEllipsoidUtils
      32                 :            : {
      33                 :            :   public:
      34                 :            : 
      35                 :            :     /**
      36                 :            :      * Contains parameters for an ellipsoid.
      37                 :            :      * \since QGIS 3.0
      38                 :            :      */
      39                 :          0 :     struct EllipsoidParameters
      40                 :            :     {
      41                 :            :       //! Whether ellipsoid parameters are valid
      42                 :          0 :       bool valid{ true };
      43                 :            : 
      44                 :            :       //! Semi-major axis
      45                 :          0 :       double semiMajor{ -1.0 };
      46                 :            :       //! Semi-minor axis
      47                 :          0 :       double semiMinor{ -1.0 };
      48                 :            : 
      49                 :            :       //! Whether custom parameters alone should be used (semiMajor/semiMinor only)
      50                 :          0 :       bool useCustomParameters{ false };
      51                 :            : 
      52                 :            :       //! Inverse flattening
      53                 :          0 :       double inverseFlattening{ -1.0 };
      54                 :            : 
      55                 :            :       //! Associated coordinate reference system
      56                 :            :       QgsCoordinateReferenceSystem crs;
      57                 :            :     };
      58                 :            : 
      59                 :            :     /**
      60                 :            :      * Contains definition of an ellipsoid.
      61                 :            :      * \since QGIS 3.0
      62                 :            :      */
      63                 :          0 :     struct EllipsoidDefinition
      64                 :            :     {
      65                 :            :       //! authority:code for QGIS builds with proj version 6 or greater, or custom acronym for ellipsoid for earlier proj builds
      66                 :            :       QString acronym;
      67                 :            :       //! Description of ellipsoid
      68                 :            :       QString description;
      69                 :            :       //! Ellipsoid parameters
      70                 :            :       QgsEllipsoidUtils::EllipsoidParameters parameters;
      71                 :            :     };
      72                 :            : 
      73                 :            :     /**
      74                 :            :      * Returns the parameters for the specified \a ellipsoid.
      75                 :            :      * Results are cached to allow for fast retrieval of parameters.
      76                 :            :      */
      77                 :            :     static EllipsoidParameters ellipsoidParameters( const QString &ellipsoid );
      78                 :            : 
      79                 :            :     /**
      80                 :            :      * Returns a list of the definitions for all known ellipsoids from the
      81                 :            :      * internal ellipsoid database.
      82                 :            :      * \see acronyms()
      83                 :            :      */
      84                 :            :     static QList< QgsEllipsoidUtils::EllipsoidDefinition > definitions();
      85                 :            : 
      86                 :            :     /**
      87                 :            :      * Returns a list of all known ellipsoid acronyms from the internal
      88                 :            :      * ellipsoid database.
      89                 :            :      * \see definitions()
      90                 :            :      */
      91                 :            :     static QStringList acronyms();
      92                 :            : 
      93                 :            : #ifndef SIP_RUN
      94                 :            : 
      95                 :            :     /**
      96                 :            :      * Clears the internal cache used.
      97                 :            :      *
      98                 :            :      * If \a disableCache is TRUE then the inbuilt cache will be completely disabled. This
      99                 :            :      * argument is for internal use only.
     100                 :            :      *
     101                 :            :      * \since QGIS 3.10
     102                 :            :      */
     103                 :            :     static void invalidateCache( bool disableCache = false );
     104                 :            : #endif
     105                 :            : };
     106                 :            : 
     107                 :            : #endif // QGSELLIPSOIDUTILS_H
     108                 :            :