qgscoordinatereferencesystem.h

Go to the documentation of this file.

/***************************************************************************
                             qgscoordinatereferencesystem.h
 
                             -------------------
    begin                : 2007
    copyright            : (C) 2007 by Gary E. Sherman
    email                : sherman@mrcc.com
***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSCOORDINATEREFERENCESYSTEM_H
#define QGSCOORDINATEREFERENCESYSTEM_H
 
//Standard includes
#include <ostream>
 
#include "qgis_core.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;
 
//qt includes
#include <QString>
#include <QMap>
#include <QHash>
#include <QReadWriteLock>
#include <QExplicitlySharedDataPointer>
#include <QObject>
 
//qgis includes
#include "qgis_sip.h"
#include "qgis.h"
#include "qgsconfig.h"
#include "qgsrectangle.h"
#include "qgssqliteutils.h"
 
class QDomNode;
class QDomDocument;
class QgsCoordinateReferenceSystemPrivate;
class QgsDatumEnsemble;
class QgsProjectionFactors;
class QgsProjOperation;
 
#ifndef SIP_RUN
struct PJconsts;
typedef struct PJconsts PJ;
 
struct pj_ctx;
typedef struct pj_ctx PJ_CONTEXT;
#endif
 
// forward declaration for sqlite3
typedef struct sqlite3 sqlite3 SIP_SKIP;
 
class QgsCoordinateReferenceSystem;
typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem & ) SIP_SKIP;

 
class CORE_EXPORT QgsCoordinateReferenceSystem
{
    Q_GADGET
 
    Q_PROPERTY( Qgis::DistanceUnit mapUnits READ mapUnits )
    Q_PROPERTY( bool isGeographic READ isGeographic )
    Q_PROPERTY( QString authid READ authid )
    Q_PROPERTY( QString description READ description )
 
  public:
    //! Enumeration of types of IDs accepted in createFromId() method
    enum CrsType
    {
      InternalCrsId, 
      PostgisCrsId,  
      EpsgCrsId      
    };

    QgsCoordinateReferenceSystem();
 
    ~QgsCoordinateReferenceSystem();
 
    // TODO QGIS 5: remove "POSTGIS" and "INTERNAL"

    explicit QgsCoordinateReferenceSystem( const QString &definition );
 
    // TODO QGIS 5: remove type and always use EPSG code

    Q_DECL_DEPRECATED explicit QgsCoordinateReferenceSystem( long id, CrsType type = PostgisCrsId ) SIP_DEPRECATED;
 
    QgsCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &srs );
    QgsCoordinateReferenceSystem &operator=( const QgsCoordinateReferenceSystem &srs );

    operator QVariant() const { return QVariant::fromValue( *this ); }

    static QList< long > validSrsIds();
 
    // static creators

    static QgsCoordinateReferenceSystem fromOgcWmsCrs( const QString &ogcCrs );

    Q_INVOKABLE static QgsCoordinateReferenceSystem fromEpsgId( long epsg );

    Q_DECL_DEPRECATED static QgsCoordinateReferenceSystem fromProj4( const QString &proj4 ) SIP_DEPRECATED;

    static QgsCoordinateReferenceSystem fromProj( const QString &proj );

    static QgsCoordinateReferenceSystem fromWkt( const QString &wkt );

    static QgsCoordinateReferenceSystem fromSrsId( long srsId );

    static QgsCoordinateReferenceSystem createCompoundCrs( const QgsCoordinateReferenceSystem &horizontalCrs, const QgsCoordinateReferenceSystem &verticalCrs, QString &error SIP_OUT );

    static QgsCoordinateReferenceSystem createGeocentricCrs( const QString &ellipsoid );
 
    // Misc helper functions -----------------------
 
    // TODO QGIS 5: remove type and always use EPSG code, rename to createFromEpsg

    Q_DECL_DEPRECATED bool createFromId( long id, CrsType type = PostgisCrsId ) SIP_DEPRECATED;
 
    // TODO QGIS 5: remove "QGIS" and "CUSTOM", only support "USER" (also returned by authid())

    bool createFromOgcWmsCrs( const QString &crs );
 
    // TODO QGIS 5: remove unless really necessary - let's use EPSG codes instead

    Q_DECL_DEPRECATED bool createFromSrid( long srid ) SIP_DEPRECATED;

    bool createFromWkt( const QString &wkt );

    bool createFromSrsId( long srsId );

    Q_DECL_DEPRECATED bool createFromProj4( const QString &projString ) SIP_DEPRECATED;

#ifndef SIP_RUN
    bool createFromProj( const QString &projString, bool identify = true );
#else
    bool createFromProj( const QString &projString );
#endif

    bool createFromString( const QString &definition );
 
    // TODO QGIS 5: rename to createFromStringOGR so it is clear it's similar to createFromString, just different backend

    bool createFromUserInput( const QString &definition );

    Q_DECL_DEPRECATED static void setupESRIWktFix() SIP_DEPRECATED;

    bool isValid() const;

    void validate();
 
    // TODO QGIS 5: seems completely obsolete now (only compares proj4 - already done in createFromProj4)

    Q_DECL_DEPRECATED long findMatchingProj() SIP_DEPRECATED;
 
    bool operator==( const QgsCoordinateReferenceSystem &srs ) const;
    bool operator!=( const QgsCoordinateReferenceSystem &srs ) const;

    bool readXml( const QDomNode &node );

    bool writeXml( QDomNode &node, QDomDocument &doc ) const;
 

    static void setCustomCrsValidation( CUSTOM_CRS_VALIDATION f ) SIP_SKIP;

    static CUSTOM_CRS_VALIDATION customCrsValidation() SIP_SKIP;
 
    // Accessors -----------------------------------

    long srsid() const;
 
    // TODO QGIS 5: remove unless really necessary - let's use EPSG codes instead

    long postgisSrid() const;

    QString authid() const;

    QString description() const;

    QString userFriendlyIdentifier( Qgis::CrsIdentifierType type = Qgis::CrsIdentifierType::MediumString ) const;

    QString projectionAcronym() const;

    QString ellipsoidAcronym() const;

    QString toWkt( Qgis::CrsWktVariant variant = Qgis::CrsWktVariant::Wkt1Gdal, bool multiline = false, int indentationWidth = 4 ) const;

    Q_DECL_DEPRECATED QString toProj4() const SIP_DEPRECATED;

    QString toProj() const;

    std::string toJsonString( bool multiline = false, int indentationWidth = 4, const QString &schema = QString() ) const;

    Qgis::CrsType type() const;

    bool isDeprecated() const;

    bool isGeographic() const;

    bool isGeographicCrossingAntimeridian() const;

    bool isDynamic() const;

    QgsDatumEnsemble datumEnsemble() const;

    QString celestialBodyName() const;

    void setCoordinateEpoch( double epoch );

    double coordinateEpoch() const;

    QgsProjectionFactors factors( const QgsPoint &point ) const;

    QgsProjOperation operation() const;

    bool hasAxisInverted() const;

#ifndef SIP_RUN
    QList< Qgis::CrsAxisDirection > axisOrdering() const;
#else
    // clang-format off
    SIP_PYOBJECT axisOrdering() const SIP_TYPEHINT( List[Qgis.CrsAxisDirection] );
    % MethodCode
    // adapted from the qpymultimedia_qlist.sip file from the PyQt6 sources
 
    const QList< Qgis::CrsAxisDirection > cppRes = sipCpp->axisOrdering();
 
    PyObject *l = PyList_New( cppRes.size() );
 
    if ( !l )
      sipIsErr = 1;
    else
    {
      for ( int i = 0; i < cppRes.size(); ++i )
      {
        PyObject *eobj = sipConvertFromEnum( static_cast<int>( cppRes.at( i ) ),
                                             sipType_Qgis_CrsAxisDirection );
 
        if ( !eobj )
        {
          sipIsErr = 1;
        }
 
        PyList_SetItem( l, i, eobj );
      }
 
      if ( !sipIsErr )
      {
        sipRes = l;
      }
      else
      {
        Py_DECREF( l );
      }
    }
    % End
// clang-format on
#endif

    Qgis::DistanceUnit mapUnits() const;

    QgsRectangle bounds() const;

    QString toOgcUri() const;

    QString toOgcUrn() const;
 
    // Mutators -----------------------------------

    void updateDefinition();

    void setValidationHint( const QString &html );

    QString validationHint() const;

    static int syncDatabase();

    long saveAsUserCrs( const QString &name, Qgis::CrsDefinitionFormat nativeFormat = Qgis::CrsDefinitionFormat::Wkt );

    void setNativeFormat( Qgis::CrsDefinitionFormat format );

    Qgis::CrsDefinitionFormat nativeFormat() const;

    QgsCoordinateReferenceSystem toGeographicCrs() const;

    QgsCoordinateReferenceSystem toGeocentricCrs() const;

    QgsCoordinateReferenceSystem horizontalCrs() const;

    QgsCoordinateReferenceSystem verticalCrs() const;

    bool hasVerticalAxis() const;

    QString geographicCrsAuthId() const;

    bool topocentricOrigin( double &latitude SIP_OUT, double &longitude SIP_OUT ) const;
 

    QgsCoordinateReferenceSystem toTopocentricCrs( double latitude, double longitude ) const;

    QgsCoordinateReferenceSystem topocentricBaseCrs() const;
 
#ifdef SIP_RUN
    // clang-format off
    SIP_PYOBJECT __repr__();
    % MethodCode
    const QString str = sipCpp->isValid() ? u"<QgsCoordinateReferenceSystem: %1%2>"_s.arg( !sipCpp->authid().isEmpty() ? sipCpp->authid() : sipCpp->toWkt( Qgis::CrsWktVariant::Preferred ),
                        std::isfinite( sipCpp->coordinateEpoch() ) ? u" @ %1"_s.arg( sipCpp->coordinateEpoch() ) : QString() )
                        : u"<QgsCoordinateReferenceSystem: invalid>"_s;
    sipRes = PyUnicode_FromString( str.toUtf8().constData() );
    % End
// clang-format on
#endif
 
#ifndef SIP_RUN

      PJ *projObject() const;

    static QgsCoordinateReferenceSystem fromProjObject( PJ *object );

    bool createFromProjObject( PJ *object );
#endif

    bool isEarthCrs() const;

    bool isSameCelestialBody( const QgsCoordinateReferenceSystem &other ) const;

    Q_DECL_DEPRECATED static QStringList recentProjections() SIP_DEPRECATED;

    Q_DECL_DEPRECATED static QList< QgsCoordinateReferenceSystem > recentCoordinateReferenceSystems() SIP_DEPRECATED;

    Q_DECL_DEPRECATED static void pushRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static void removeRecentCoordinateReferenceSystem( const QgsCoordinateReferenceSystem &crs ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static void clearRecentCoordinateReferenceSystems() SIP_DEPRECATED;
 
#ifndef SIP_RUN

    static void invalidateCache( bool disableCache = false );
#else

    static void invalidateCache( bool disableCache SIP_PYARGREMOVE = false );
#endif
 
    // Mutators -----------------------------------
    // We don't want to expose these to the public api since they won't create
    // a fully valid crs. Programmers should use the createFrom* methods rather
  private:
    static QString projFromSrsId( int srsId );
 
    static const QMap<QString, QString> &authIdToQgisSrsIdMap();

    void setProjString( const QString &projString );

    bool setWktString( const QString &wkt );

    void debugPrint();

    typedef QMap<QString, QString> RecordMap;

    RecordMap getRecord( const QString &sql );

    static int openDatabase( const QString &path, sqlite3_database_unique_ptr &database, bool readonly = true );

    void setMapUnits();
 
    void setExtraProperties();

    static long getRecordCount();

    bool loadFromAuthCode( const QString &auth, const QString &code );

    static QList< long > userSrsIds();

    long matchToUserCrs() const;

    bool loadFromDatabase( const QString &db, const QString &expression, const QString &value );
 
    bool createFromWktInternal( const QString &wkt, const QString &description );
 
    QExplicitlySharedDataPointer<QgsCoordinateReferenceSystemPrivate> d;
 
    QString mValidationHint;
 
    Qgis::CrsDefinitionFormat mNativeFormat = Qgis::CrsDefinitionFormat::Wkt;
 
    friend class QgsProjContext;
 
    // Only meant to be called by QgsProjContext::~QgsProjContext()
    static void removeFromCacheObjectsBelongingToCurrentThread( PJ_CONTEXT *pj_context );

    static CUSTOM_CRS_VALIDATION sCustomSrsValidation;
 
    // cache
    static bool sDisableSrIdCache;
    static bool sDisableOgcCache;
    static bool sDisableProjCache;
    static bool sDisableWktCache;
    static bool sDisableSrsIdCache;
    static bool sDisableStringCache;
 
    // for tests
    static const QHash< QString, QgsCoordinateReferenceSystem > &stringCache();
    static const QHash< QString, QgsCoordinateReferenceSystem > &projCache();
    static const QHash< QString, QgsCoordinateReferenceSystem > &ogcCache();
    static const QHash< QString, QgsCoordinateReferenceSystem > &wktCache();
    static const QHash< long, QgsCoordinateReferenceSystem > &srsIdCache();
    static const QHash< long, QgsCoordinateReferenceSystem > &srIdCache();
 
    friend class TestQgsCoordinateReferenceSystem;
    friend class QgsCoordinateReferenceSystemRegistry;
    friend bool CORE_EXPORT operator>( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
    friend bool CORE_EXPORT operator<( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
    friend bool CORE_EXPORT operator>=( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
    friend bool CORE_EXPORT operator<=( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
 
    bool createFromPostgisSrid( const long id );
};
 
Q_DECLARE_METATYPE( QgsCoordinateReferenceSystem )
 

#ifndef SIP_RUN
inline std::ostream &operator<<( std::ostream &os, const QgsCoordinateReferenceSystem &r )
{
  QString mySummary( u"\n\tSpatial Reference System:"_s );
  mySummary += "\n\t\tDescription : "_L1;
  if ( !r.description().isNull() )
  {
    mySummary += r.description();
  }
  else
  {
    mySummary += "Undefined"_L1;
  }
  mySummary += "\n\t\tProjection  : "_L1;
  if ( !r.projectionAcronym().isNull() )
  {
    mySummary += r.projectionAcronym();
  }
  else
  {
    mySummary += "Undefined"_L1;
  }
 
  mySummary += "\n\t\tEllipsoid   : "_L1;
  if ( !r.ellipsoidAcronym().isNull() )
  {
    mySummary += r.ellipsoidAcronym();
  }
  else
  {
    mySummary += "Undefined"_L1;
  }
 
  mySummary += "\n\t\tProjString  : "_L1;
  if ( !r.toProj().isNull() )
  {
    mySummary += r.toProj();
  }
  else
  {
    mySummary += "Undefined"_L1;
  }
  // Using streams we need to use local 8 Bit
  return os << mySummary.toLocal8Bit().data() << std::endl;
}
 
bool CORE_EXPORT operator>( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
bool CORE_EXPORT operator<( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
bool CORE_EXPORT operator>=( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
bool CORE_EXPORT operator<=( const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2 );
#endif
 
#endif // QGSCOORDINATEREFERENCESYSTEM_H