qgscoordinatetransformcontext.h

Go to the documentation of this file.

/***************************************************************************
                         qgscoordinatetransformcontext.h
                         -------------------------------
    begin                : November 2017
    copyright            : (C) 2017 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 QGSCOORDINATETRANSFORMCONTEXT_H
#define QGSCOORDINATETRANSFORMCONTEXT_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsdatumtransform.h"
 
#include <QExplicitlySharedDataPointer>
#include <QMetaType>
 
class QgsCoordinateReferenceSystem;
class QgsReadWriteContext;
class QgsCoordinateTransformContextPrivate;
class QDomElement;
class QgsSettingsEntryBool;
class QgsSettingsEntryString;
class QgsSettingsTreeNamedListNode;
 
/***************************************************************************
 * This class is considered CRITICAL and any change MUST be accompanied with
 * full unit tests in testqgsfeature.cpp.
 * See details in QEP #17
 ****************************************************************************/

 
class CORE_EXPORT QgsCoordinateTransformContext
{
  public:
#ifndef SIP_RUN
    static QgsSettingsTreeNamedListNode *sTreeCoordinateOperationsSource;
    static QgsSettingsTreeNamedListNode *sTreeCoordinateOperationsDestination;
    static const QgsSettingsEntryString *settingsCoordinateOperation SIP_SKIP;
    static const QgsSettingsEntryBool *settingsAllowFallback SIP_SKIP;
#endif

    QgsCoordinateTransformContext();
 
    ~QgsCoordinateTransformContext();
 
    QgsCoordinateTransformContext( const QgsCoordinateTransformContext &rhs );
    SIP_SKIP QgsCoordinateTransformContext( QgsCoordinateTransformContext &&rhs );
    QgsCoordinateTransformContext &operator=( const QgsCoordinateTransformContext &rhs ) SIP_SKIP;
    QgsCoordinateTransformContext &operator=( QgsCoordinateTransformContext &&rhs );
 
    bool operator==( const QgsCoordinateTransformContext &rhs ) const;
    bool operator!=( const QgsCoordinateTransformContext &rhs ) const;

    void clear();

    Q_DECL_DEPRECATED QMap< QPair< QString, QString>, QgsDatumTransform::TransformPair > sourceDestinationDatumTransforms() const SIP_DEPRECATED;

    QMap< QPair< QString, QString>, QString > coordinateOperations() const;

    Q_DECL_DEPRECATED bool addSourceDestinationDatumTransform(
      const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, int sourceTransformId, int destinationTransformId
    ) SIP_DEPRECATED;

    bool addCoordinateOperation( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &coordinateOperationProjString, bool allowFallback = true );

    Q_DECL_DEPRECATED void removeSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs ) SIP_DEPRECATED;

    void removeCoordinateOperation( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs );

    bool hasTransform( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;

    Q_DECL_DEPRECATED QgsDatumTransform::TransformPair calculateDatumTransforms( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const SIP_DEPRECATED;

    QString calculateCoordinateOperation( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;

    bool allowFallbackTransform( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;

    bool mustReverseCoordinateOperation( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;
 
    // TODO QGIS 5.0 - remove missingTransforms, not used for Proj >= 6.0 builds

    bool readXml( const QDomElement &element, const QgsReadWriteContext &context, QStringList &missingTransforms SIP_OUT );

    void writeXml( QDomElement &element, const QgsReadWriteContext &context ) const;
 

    void readSettings();

    void writeSettings();
 
 
  private:
    QExplicitlySharedDataPointer<QgsCoordinateTransformContextPrivate> d;
};
 
Q_DECLARE_METATYPE( QgsCoordinateTransformContext )
 
#endif // QGSCOORDINATETRANSFORMCONTEXT_H