QGIS API Documentation  3.15.0-Master (ecc6bfcd7a)
qgscoordinatetransformcontext.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgscoordinatetransformcontext.h
3  -------------------------------
4  begin : November 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSCOORDINATETRANSFORMCONTEXT_H
19 #define QGSCOORDINATETRANSFORMCONTEXT_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgsdatumtransform.h"
24 
25 #include <QMetaType>
26 #include <QExplicitlySharedDataPointer>
29 class QgsCoordinateTransformContextPrivate;
30 class QDomElement;
31 
32 /***************************************************************************
33  * This class is considered CRITICAL and any change MUST be accompanied with
34  * full unit tests in testqgsfeature.cpp.
35  * See details in QEP #17
36  ****************************************************************************/
37 
58 {
59  public:
60 
65 
67 
72 
77 
78  bool operator==( const QgsCoordinateTransformContext &rhs ) const ;
79 
83  void clear();
84 
100  Q_DECL_DEPRECATED QMap< QPair< QString, QString>, QgsDatumTransform::TransformPair > sourceDestinationDatumTransforms() const SIP_DEPRECATED;
101 
117  QMap< QPair< QString, QString>, QString > coordinateOperations() const;
118 
133  Q_DECL_DEPRECATED bool addSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, int sourceTransformId, int destinationTransformId ) SIP_DEPRECATED;
134 
166  bool addCoordinateOperation( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs, const QString &coordinateOperationProjString, bool allowFallback = true );
167 
175  Q_DECL_DEPRECATED void removeSourceDestinationDatumTransform( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs ) SIP_DEPRECATED ;
176 
182  void removeCoordinateOperation( const QgsCoordinateReferenceSystem &sourceCrs, const QgsCoordinateReferenceSystem &destinationCrs );
183 
189  bool hasTransform( const QgsCoordinateReferenceSystem &source,
190  const QgsCoordinateReferenceSystem &destination ) const;
191 
202  Q_DECL_DEPRECATED QgsDatumTransform::TransformPair calculateDatumTransforms( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const SIP_DEPRECATED;
203 
223  QString calculateCoordinateOperation( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;
224 
234  bool allowFallbackTransform( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;
235 
242  bool mustReverseCoordinateOperation( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) const;
243 
244  // TODO QGIS 4.0 - remove missingTransforms, not used for Proj >= 6.0 builds
245 
254  bool readXml( const QDomElement &element, const QgsReadWriteContext &context, QStringList &missingTransforms SIP_OUT );
255 
260  void writeXml( QDomElement &element, const QgsReadWriteContext &context ) const;
261 
262 
267  void readSettings();
268 
273  void writeSettings();
274 
275 
276  private:
277 
278  QExplicitlySharedDataPointer<QgsCoordinateTransformContextPrivate> d;
279 
280 };
281 
283 
284 #endif // QGSCOORDINATETRANSFORMCONTEXT_H
285 
286 
287 
288 
The class is used as a container of context for various read/write operations on other objects...
bool operator==(const QgsFeatureIterator &fi1, const QgsFeatureIterator &fi2)
#define SIP_SKIP
Definition: qgis_sip.h:126
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
Contains information about the context in which a coordinate transform is executed.
#define SIP_DEPRECATED
Definition: qgis_sip.h:106
Contains datum transform information.
#define SIP_OUT
Definition: qgis_sip.h:58
This class represents a coordinate reference system (CRS).