qgsdatumtransform.h

Go to the documentation of this file.

/***************************************************************************
               qgsdatumtransform.h
               ------------------------
    begin                : Dec 2017
    copyright            : (C) 2017 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 QGSDATUMTRANSFORM_H
#define QGSDATUMTRANSFORM_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsrectangle.h"
 
#include <QList>
#include <QString>
 
class QgsCoordinateReferenceSystem;
 
#ifndef SIP_RUN
struct PJconsts;
typedef struct PJconsts PJ;
#endif

class CORE_EXPORT QgsDatumTransform
{
  public:
    struct TransformPair
    {
        TransformPair( int sourceTransformId = -1, int destinationTransformId = -1 )
          : sourceTransformId( sourceTransformId )
          , destinationTransformId( destinationTransformId )
        {}

        int sourceTransformId = -1;

        int destinationTransformId = -1;
 
        // TODO c++20 - replace with = default
        bool operator==( QgsDatumTransform::TransformPair other ) const { return other.sourceTransformId == sourceTransformId && other.destinationTransformId == destinationTransformId; }
 
        bool operator!=( QgsDatumTransform::TransformPair other ) const { return other.sourceTransformId != sourceTransformId || other.destinationTransformId != destinationTransformId; }
    };

    struct TransformInfo
    {
        int datumTransformId = -1;

        int epsgCode = 0;

        QString sourceCrsAuthId;

        QString destinationCrsAuthId;

        QString sourceCrsDescription;

        QString destinationCrsDescription;

        QString remarks;

        QString scope;

        bool preferred = false;

        bool deprecated = false;
    };
 

    struct GridDetails
    {
        QString shortName;
        QString fullName;
        QString packageName;
        QString url;
        bool directDownload = false;
        bool openLicense = false;
        bool isAvailable = false;
    };

    struct SingleOperationDetails
    {
        QString scope;

        QString remarks;

        QString areaOfUse;

        QString authority;

        QString code;
    };

    struct TransformDetails
    {
        QString proj;
        QString name;
        double accuracy = 0;

        QString authority;

        QString code;

        QString scope;

        QString remarks;

        bool isAvailable = false;

        QString areaOfUse;

        QgsRectangle bounds;

        QList< QgsDatumTransform::GridDetails > grids;

        QList< QgsDatumTransform::SingleOperationDetails > operationDetails;
    };

    static QList< QgsDatumTransform::TransformDetails > operations( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination, bool includeSuperseded = false );

    Q_DECL_DEPRECATED static QList< QgsDatumTransform::TransformPair > datumTransformations( const QgsCoordinateReferenceSystem &source, const QgsCoordinateReferenceSystem &destination ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static QString datumTransformToProj( int datumTransformId ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static int projStringToDatumTransformId( const QString &string ) SIP_DEPRECATED;

    Q_DECL_DEPRECATED static QgsDatumTransform::TransformInfo datumTransformInfo( int datumTransformId ) SIP_DEPRECATED;
 
#ifndef SIP_RUN

    static QgsDatumTransform::TransformDetails transformDetailsFromPj( PJ *op );
#endif
 
  private:
    static void searchDatumTransform( const QString &sql, QList< int > &transforms );
};
 
#endif // QGSDATUMTRANSFORM_H