qgscoordinatereferencesystem.h

Go to the documentation of this file.

/***************************************************************************
                             qgscoordinatereferencesystem.h

                             -------------------
    begin                : 2007
    copyright            : (C) 2007 by Gary E. Sherman
    email                : [email protected]
***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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>

//qt includes
#include <QString>
#include <QMap>
#include <QHash>

class QDomNode;
class QDomDocument;

// forward declaration for sqlite3
typedef struct sqlite3 sqlite3;

//qgis includes
#include "qgis.h"

#ifdef DEBUG
typedef struct OGRSpatialReferenceHS *OGRSpatialReferenceH;
#else
typedef void *OGRSpatialReferenceH;
#endif

class QgsCoordinateReferenceSystem;
typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem& );

class CORE_EXPORT QgsCoordinateReferenceSystem
{
  public:

    enum CrsType
    {
      InternalCrsId,
      PostgisCrsId,
      EpsgCrsId     // deprecated
    };

    QgsCoordinateReferenceSystem();

    ~QgsCoordinateReferenceSystem();

    explicit QgsCoordinateReferenceSystem( const QString& theDefinition );

    QgsCoordinateReferenceSystem( const long theId, CrsType theType = PostgisCrsId );

    QgsCoordinateReferenceSystem( const QgsCoordinateReferenceSystem& srs );

    QgsCoordinateReferenceSystem& operator=( const QgsCoordinateReferenceSystem& srs );

    // Misc helper functions -----------------------

    bool createFromId( const long theId, CrsType theType = PostgisCrsId );

    bool createFromOgcWmsCrs( QString theCrs );

    bool createFromSrid( const long theSrid );

    bool createFromWkt( const QString &theWkt );

    bool createFromSrsId( const long theSrsId );

    bool createFromProj4( const QString &theProjString );

    bool createFromString( const QString &theDefinition );

    bool createFromUserInput( const QString &theDefinition );

    static void setupESRIWktFix();

    bool isValid() const;

    void validate();

    long findMatchingProj();

    bool operator==( const QgsCoordinateReferenceSystem &theSrs ) const;
    bool operator!=( const QgsCoordinateReferenceSystem &theSrs ) const;

    bool readXML( const QDomNode & theNode );
    bool writeXML( QDomNode & theNode, QDomDocument & theDoc ) const;


    static void setCustomSrsValidation( CUSTOM_CRS_VALIDATION f );

    static CUSTOM_CRS_VALIDATION customSrsValidation();

    // Accessors -----------------------------------

    long srsid() const;

    long postgisSrid() const;

    QString authid() const;

    QString description() const;

    QString projectionAcronym() const;

    QString ellipsoidAcronym() const;

    QString toWkt() const;

    QString toProj4() const;

    //TODO QGIS 3.0 - rename to isGeographic
    bool geographicFlag() const;

    bool axisInverted() const;

    QGis::UnitType mapUnits() const;


    // Mutators -----------------------------------
    void setValidationHint( const QString& html );

    QString validationHint();
    static int syncDb();


    bool saveAsUserCRS( const QString& name );

    QString geographicCRSAuthId() const;

    static QStringList recentProjections();

    // Mutators -----------------------------------
    // We don't want to expose these to the public api since they wont create
    // a fully valid crs. Programmers should use the createFrom* methods rather
  private:
    static QString proj4FromSrsId( const int theSrsId );

    void setInternalId( long theSrsId );
    void setSrid( long theSrid );
    void setDescription( const QString& theDescription );

    void setProj4String( const QString& theProj4String );

    void setGeographicFlag( bool theGeoFlag );

    void setEpsg( long theEpsg );

    void setAuthId( const QString& theID );
    void setProjectionAcronym( const QString& theProjectionAcronym );
    void setEllipsoidAcronym( const QString& theEllipsoidAcronym );

    void debugPrint();

    typedef QMap<QString, QString> RecordMap;
    RecordMap getRecord( const QString& theSql );

    // Open SQLite db and show message if cannot be opened
    // returns the same code as sqlite3_open
    static int openDb( const QString& path, sqlite3 **db, bool readonly = true );

    long    mSrsId;
    QString mDescription;
    QString mProjectionAcronym;
    QString mEllipsoidAcronym;
    bool    mGeoFlag;
    QGis::UnitType mMapUnits;
    long    mSRID;
    QString mAuthId;
    bool mIsValidFlag;

    void setMapUnits();

    long getRecordCount();

    static QString quotedValue( QString value );

    OGRSpatialReferenceH mCRS;

    bool loadFromDb( const QString& db, const QString& expression, const QString& value );

    QString mValidationHint;
    mutable QString mWkt;
    mutable QString mProj4;

    static bool loadIDs( QHash<int, QString> &wkts );
    static bool loadWkts( QHash<int, QString> &wkts, const char *filename );
    static bool syncDatumTransform( const QString& dbPath );

    mutable int mAxisInverted;

    static CUSTOM_CRS_VALIDATION mCustomSrsValidation;
};


inline std::ostream& operator << ( std::ostream& os, const QgsCoordinateReferenceSystem &r )
{
  QString mySummary( "\n\tSpatial Reference System:" );
  mySummary += "\n\t\tDescription : ";
  if ( !r.description().isNull() )
  {
    mySummary += r.description();
  }
  else
  {
    mySummary += "Undefined";
  }
  mySummary += "\n\t\tProjection  : ";
  if ( !r.projectionAcronym().isNull() )
  {
    mySummary += r.projectionAcronym();
  }
  else
  {
    mySummary += "Undefined";
  }

  mySummary += "\n\t\tEllipsoid   : ";
  if ( !r.ellipsoidAcronym().isNull() )
  {
    mySummary += r.ellipsoidAcronym();
  }
  else
  {
    mySummary += "Undefined";
  }

  mySummary += "\n\t\tProj4String  : ";
  if ( !r.toProj4().isNull() )
  {
    mySummary += r.toProj4();
  }
  else
  {
    mySummary += "Undefined";
  }
  // Using streams we need to use local 8 Bit
  return os << mySummary.toLocal8Bit().data() << std::endl;
}

#endif // QGSCOORDINATEREFERENCESYSTEM_H