qgscoordinatereferencesystemregistry.h

Go to the documentation of this file.

/***************************************************************************
                             qgscoordinatereferencesystemregistry.h
                             -------------------
    begin                : January 2021
    copyright            : (C) 2021 by Nyall Dawson
    email                : nyall dot dawson at gmail dot 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 QGSCOORDINATEREFERENCESYSTEMREGISTRY_H
#define QGSCOORDINATEREFERENCESYSTEMREGISTRY_H
 
#include "qgscoordinatereferencesystem.h"
 
#include <QMap>
#include <QObject>
#include <QSet>
 
class QgsCelestialBody;
class QgsProjOperation;
class QgsSettingsEntryStringList;
 
 
#ifndef SIP_RUN

struct CORE_EXPORT QgsCrsDbRecord
{
    QString description;
    QString projectionAcronym;
    QString srsId;
    QString authName;
    QString authId;
    Qgis::CrsType type = Qgis::CrsType::Unknown;
    bool deprecated = false;
};
#endif

class CORE_EXPORT QgsCoordinateReferenceSystemRegistry : public QObject
{
    Q_OBJECT
  public:
    static const QgsSettingsEntryStringList *settingsRecentProjectionsAuthId SIP_SKIP;
 
    static const QgsSettingsEntryStringList *settingsRecentProjectionsWkt SIP_SKIP;
 
    static const QgsSettingsEntryStringList *settingsRecentProjectionsProj4 SIP_SKIP;

    explicit QgsCoordinateReferenceSystemRegistry( QObject *parent = nullptr );
 
    ~QgsCoordinateReferenceSystemRegistry() override;

    class UserCrsDetails
    {
      public:
        long id = -1;

        QString name;

        QString proj;

        QString wkt;

        QgsCoordinateReferenceSystem crs;
    };

    QList< QgsCoordinateReferenceSystemRegistry::UserCrsDetails > userCrsList() const;

    long addUserCrs( const QgsCoordinateReferenceSystem &crs, const QString &name, Qgis::CrsDefinitionFormat nativeFormat = Qgis::CrsDefinitionFormat::Wkt );

    bool updateUserCrs( long id, const QgsCoordinateReferenceSystem &crs, const QString &name, Qgis::CrsDefinitionFormat nativeFormat = Qgis::CrsDefinitionFormat::Wkt );

    bool removeUserCrs( long id );

    QMap< QString, QgsProjOperation > projOperations() const;

    QList< QgsCelestialBody > celestialBodies() const;

    QSet< QString > authorities() const;

    QList< QgsCrsDbRecord > crsDbRecords() const SIP_SKIP;

    QList< QgsCoordinateReferenceSystem > recentCrs();

    void pushRecent( const QgsCoordinateReferenceSystem &crs );

    void removeRecent( const QgsCoordinateReferenceSystem &crs );

    void clearRecent();
 
  signals:

    void userCrsChanged( const QString &id );

    void userCrsAdded( const QString &id );

    void userCrsRemoved( long id );

    void crsDefinitionsChanged();

    void recentCrsPushed( const QgsCoordinateReferenceSystem &crs );

    void recentCrsRemoved( const QgsCoordinateReferenceSystem &crs );

    void recentCrsCleared();
 
  private:
    bool insertProjection( const QString &projectionAcronym );
 
    mutable QReadWriteLock mCrsDbRecordsLock;
    mutable bool mCrsDbRecordsPopulated = false;
    mutable QList< QgsCrsDbRecord > mCrsDbRecords;
};
 
 
#endif // QGSCOORDINATEREFERENCESYSTEMREGISTRY_H