/usr/include/qgis/qgscoordinatereferencesystem.h is in libqgis-dev 1.7.4+1.7.5~20120320-1.1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 | /***************************************************************************
qgscoordinatereferencesystem.h
-------------------
begin : 2007
copyright : (C) 2007 by Gary E. Sherman
email : sherman@mrcc.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 QGSCOORDINATEREFERENCESYSTEM_H
#define QGSCOORDINATEREFERENCESYSTEM_H
//Standard includes
#include <ostream>
//qt includes
#include <QString>
#include <QMap>
class QDomNode;
class QDomDocument;
// forward declaration for sqlite3
typedef struct sqlite3 sqlite3;
//qgis includes
#include "qgis.h"
class QgsCoordinateReferenceSystem;
typedef void ( *CUSTOM_CRS_VALIDATION )( QgsCoordinateReferenceSystem* );
/** \ingroup core
* Class for storing a coordinate reference system (CRS)
*/
class CORE_EXPORT QgsCoordinateReferenceSystem
{
public:
enum CrsType
{
InternalCrsId,
PostgisCrsId,
EpsgCrsId // deprecated
};
//! Default constructor
QgsCoordinateReferenceSystem();
~QgsCoordinateReferenceSystem();
/*!
* Constructs a CRS object from a string definition as defined in the createFromString
* member function (by default a WKT definition).
* @param theDefinition A String containing a coordinate reference system definition.
*/
explicit QgsCoordinateReferenceSystem( QString theDefinition );
/*! Use this constructor when you want to create a CRS object using
* a postgis SRID, an EpsgCrsId id or a QGIS CRS_ID.
* @note We encourage you to use EpsgCrsId, Wkt or Proj4 to describe CRS's in your code
* wherever possible. QGSI CRS_IDs are not guaranteed to be permanent / involatile.
* @param theId The ID no valid for the chosen coordinate system id type
* @param theType One of the types described in QgsCoordinateReferenceSystem::CrsType
*/
QgsCoordinateReferenceSystem( const long theId, CrsType theType = PostgisCrsId );
//! copy constructor
QgsCoordinateReferenceSystem( const QgsCoordinateReferenceSystem& srs );
//! Assignment operator
QgsCoordinateReferenceSystem& operator=( const QgsCoordinateReferenceSystem& srs );
// Misc helper functions -----------------------
bool createFromId( const long theId, CrsType theType = PostgisCrsId );
/**
* \brief Set up this CRS from the given OGC CRS
*
* Sets this CRS to the given OGC WMS-format Coordinate Reference Systems.
*
* \retval false if not given an valid label
*/
bool createFromOgcWmsCrs( QString theCrs );
/*! Set up this srs by fetching the appropriate information from the
* sqlite backend. First the system level read only srs.db will be checked
* and then the users ~/.qgis/qgis.db database will be checked for a match.
* @note Any members will be overwritten during this process.
* @param theSrid The postgis SRID for the desired spatial reference system.
*/
bool createFromSrid( const long theSrid );
/*! Set up this srs using a Wkt spatial ref sys definition.
* The wkt will be converted to a proj4 string using OGR helper
* functions. After this the srs databasses will be searched for matches.
* First the system level read only srs.db will be checked
* and then the users ~/.qgis/qgis.db database will be checked for a match.
* @note Any members will be overwritten during this process.
* @note SRID and EpsgCrsId may be blank if no match can be found on srs db.
* @param theWkt The Wkt for the desired spatial reference system.
* @return bool TRUE if success else false
*/
bool createFromWkt( const QString theWkt );
/*! Set up this srs by fetching the appropriate information from the
* sqlite backend. First the system level read only srs.db will be checked
* and then the users ~/.qgis/qgis.db database will be checked for a match.
* @note Any members will be overwritten during this process.
* @param theEpsg The EpsgCrsId for the desired spatial reference system.
* @return bool TRUE if success else false
* @deprecated use createFromOgcWmsCrs()
*/
Q_DECL_DEPRECATED bool createFromEpsg( const long theEpsg );
/*! Set up this srs by fetching the appropriate information from the
* sqlite backend. If the srsid is < 100000, only the system srs.db
* will be checked. If the srsid > 100000 the srs will be retrieved from
* the ~/.qgis/qgis.db
* @note Any members will be overwritten during this process.
* @param theSrsId The QGIS SrsId for the desired spatial reference system.
* @return bool TRUE if success else false
*/
bool createFromSrsId( const long theSrsId );
/*! Set up this srs by passing it a proj4 style formatted string.
* The string will be parsed and the projection and ellipsoid
* members set and the remainder of the proj4 string will be stored
* in the parameters member. The reason for this is so that we
* can easily present the user with 'natural language' representation
* of the projection and ellipsoid by looking them up in the srs.bs sqlite
* database. Also having the ellpse and proj elements stripped out
* is hepful to speed up globbing queries (see below).
*
* We try to match the proj string to and srsid using the following logic:
*
* - perform a whole text search on srs name (if not null). The srs name will
* have been set if this method has been delegated to from createFromWkt.
* - if the above does not match perform a whole text search on proj4 string (if not null)
* - if none of the above match convert the proj4 string to an OGR CRS
* then check if its a geocs or a proj cs (using ogr isGeographic)
* then sequentially walk through the database (first users qgis.db srs tbl then
* system srs.db tbl), converting each entry into an ogr srs and using isSame
* or isSameGeocs (essentially calling the == overloaded operator). We'll try to
* be smart about this and first parse out the proj and ellpse strings and only
* check for a match in entities that have the same ellps and proj entries so
* that it doesn't munch yer cpu so much.
*
* @note If the srs was not matched, we will create a new entry on the users tbl_srs
* for this srs.
*
* @param theProjString A proj4 format string
* @return bool TRUE if success else false
*/
bool createFromProj4( const QString theProjString );
/*! Set up this srs from a string definition, by default a WKT definition. Otherwise
* the string defines a authority, followed by a colon, followed by the definition.
* The authority can be one of "epsg", "postgis", "internal" for integer definitions,
* and "wkt" or "proj4" for string definitions. The implementation of each authority
* uses the corresponding createFrom... function.
* @param theDefinition A String containing a coordinate reference system definition.
*/
bool createFromString( const QString theDefinition );
/*! Find out whether this CRS is correctly initialised and usable */
bool isValid() const;
/*! Perform some validation on this CRS. If the sts doesn't validate the
* default behaviour settings for layers with unknown CRS will be
* consulted and acted on accordingly. By hell or high water this
* method will do its best to make sure that this CRS is valid - even
* if that involves resorting to a hard coded default of geocs:wgs84.
*
* @note It is not usually necessary to use this function, unless you
* are trying to force this srs to be valid.
*/
void validate();
/*! This is a globbing function to try to find a record in the database
* that matches a CRS defined only by a proj4string. The goal is to
* learn what the tbl_srs.srs_id value is for the CRS. Internally
* the source CRS is converted to an OGR srs object using the proj4string call
* and then every record in the database that matches projection and ellipsoid
* will be converted to an OGR srs in turn and compared to the source CRS.
* There are some gotchas with using ogr isSame() srs comparison, but
* its more effective than using straight string comparison of proj4params.
* @note The ellipsoid and projection acronyms must be set as well as the proj4string!
* @return long the SrsId of the matched CRS
*/
long findMatchingProj();
/*! Overloaded == operator used to compare to CRS's.
* Internally it will delegate to the equals method described below
*/
bool operator==( const QgsCoordinateReferenceSystem &theSrs );
/*! Overloaded != operator used to compare to CRS's.
* Returns opposite bool value to operator ==
*/
bool operator!=( const QgsCoordinateReferenceSystem &theSrs );
/*! Overloaded == operator used to compare to CRS's.
* Internally it will use OGR isSameCRS() or isSameGeoCRS() methods as appropriate.
* Additionally logic may also be applied if the result from the OGR methods
* is inconclusive.
*/
bool equals( QString theProj4String );
/*! Restores state from the given Dom node.
* @param theNode The node from which state will be restored
* @return bool True on success, False on failure
*/
bool readXML( QDomNode & theNode );
/*! Stores state to the given Dom node in the given document.
* Below is an example of the generated tag.
\verbatim
<spatialrefsys>
<proj4>+proj=longlat +ellps=WGS84 +datum=WGS84 +no_defs </proj4>
<srsid>2585</srsid>
<srid>4326</srid>
<epsg>4326</epsg>
<description>WGS 84</description>
<projectionacronym>longlat</projectionacronym>
<ellipsoidacronym>WGS84</ellipsoidacronym>
</spatialrefsys>
\endverbatim
* @param theNode The node in which state will be restored
* @param theDoc The document in which state will be stored
* @return bool True on success, False on failure
*/
bool writeXML( QDomNode & theNode, QDomDocument & theDoc ) const;
/** Sets custom function to force valid CRS
* QGIS uses implementation in QgisGui::customSrsValidation
*/
static void setCustomSrsValidation( CUSTOM_CRS_VALIDATION f );
/** Gets custom function
*/
static CUSTOM_CRS_VALIDATION customSrsValidation();
// Accessors -----------------------------------
/*! Get the SrsId - if possible
* @return long theSrsId The internal sqlite3 srs.db primary key for this srs
*/
long srsid() const;
/*! Get the postgis srid for this srs
* @return long theSRID the Postgis spatial_ref_sys identifier for this srs (defaults to 0)
*/
long postgisSrid() const;
/*! Get the EpsgCrsId identifier for this srs
* @return long theEpsg the EPSG identifier for this srs (defaults to 0)
* @deprecated there are other authorities - use authid()
*/
Q_DECL_DEPRECATED long epsg() const;
/*! Get the authority identifier for this srs
* @return QString the Authority identifier for this srs
* @note added in 1.5
*/
QString authid() const;
/*! Get the Description
* @return QString the Description A textual description of the srs.
* @note A zero length string will be returned if the description is uninitialised
*/
QString description() const;
/*! Get the Projection Acronym
* @return QString theProjectionAcronym The official proj4 acronym for the projection family
* @note A zero length string will be returned if the projectionAcronym is uninitialised
*/
QString projectionAcronym() const;
/*! Get the Ellipsoid Acronym
* @return QString theEllipsoidAcronym The official proj4 acronym for the ellipoid
* @note A zero length string will be returned if the ellipsoidAcronym is uninitialised
*/
QString ellipsoidAcronym() const;
/*! A helper to get an wkt representation of this srs
* @return string containing Wkt of the srs
*/
QString toWkt() const;
/** Get the Proj Proj4 string representation of this srs.
* If proj and ellps keys are found in the parameters,
* they will be stripped out and the Projection and ellipsoid acronyms will be
* overridden with these.
* @return QString theProj4String Proj4 format specifies that define this srs.
* @note A zero length string will be returned if the toProj4 is uninitialised
*/
QString toProj4() const;
/*! Get this Geographic? flag
* @return bool theGeoFlag Whether this is a geographic or projected coordinate system
*/
bool geographicFlag() const;
/*! Get the units that the projection is in
* @return QGis::UnitType that gives the units for the coordinate system
*/
QGis::UnitType mapUnits() const;
// Mutators -----------------------------------
/*! Set user hint for validation
*/
void setValidationHint( QString html );
/*! Get user hint for validation
*/
QString validationHint();
// 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:
/** A static helper function to find out the proj4 string for a srsid
* @param theSrsId The srsid used for the lookup
* @return QString The proj4 string
*/
static QString proj4FromSrsId( const int theSrsId );
/*! Set the QGIS SrsId
* @param theSrsId The internal sqlite3 srs.db primary key for this srs
*/
void setInternalId( long theSrsId );
/*! Set the postgis srid
* @param theSrid The postgis spatial_ref_sys key for this srs
*/
void setSrid( long theSrid );
/*! Set the Description
* @param theDescription A textual description of the srs.
*/
void setDescription( QString theDescription );
/* Set the Proj Proj4String.
* @param QString theProj4String Proj4 format specifies (excluding proj and ellips) that define this srs.
*/
void setProj4String( QString theProj4String );
/*! Set this Geographic? flag
* @param theGeoFlag Whether this is a geographic or projected coordinate system
*/
void setGeographicFlag( bool theGeoFlag );
/*! Set the EpsgCrsId identifier for this srs
* @param theEpsg the ESPG identifier for this srs (defaults to 0)
*/
void setEpsg( long theEpsg );
/*! Set the authority identifier for this srs
* @param theID the authority identifier for this srs (defaults to 0)
*/
void setAuthId( QString theID );
/*! Set the projection acronym
* @param theProjectionAcronym the acronym (must be a valid proj4 projection acronym)
*/
void setProjectionAcronym( QString theProjectionAcronym );
/*! Set the ellipsoid acronym
* @param theEllipsoidAcronym the acronym (must be a valid proj4 ellipsoid acronym)
*/
void setEllipsoidAcronym( QString theEllipsoidAcronym );
/*! Print the description if debugging
*/
void debugPrint();
/*! A string based associative array used for passing records around */
typedef QMap<QString, QString> RecordMap;
/*! Get a record from the srs.db or qgis.db backends, given an sql statment.
* @note only handles queries that return a single record.
* @note it will first try the system srs.db then the users qgis.db!
* @param theSql The sql query to execute
* @return An associative array of field name <-> value pairs
*/
RecordMap getRecord( QString theSql );
// Open SQLite db and show message if ccannot be opened
// returns the same code as sqlite3_open
static int openDb( QString path, sqlite3 **db );
//!The internal sqlite3 srs.db primary key for this srs
long mSrsId;
//!A textual description of the srs.
QString mDescription;
//!The official proj4 acronym for the projection family
QString mProjectionAcronym ;
//!The official proj4 acronym for the ellipoid
QString mEllipsoidAcronym;
//!Whether this is a geographic or projected coordinate system
bool mGeoFlag;
//! The map units
QGis::UnitType mMapUnits;
//!If available, the Postgis spatial_ref_sys identifier for this srs (defaults to 0)
long mSRID;
//!If available the authority identifier for this srs
QString mAuthId;
//! Wehter this srs is properly defined and valid
bool mIsValidFlag;
//! Work out the projection units and set the appropriate local variable
void setMapUnits();
//! Save the proj4-string as a custom CRS
bool saveAsUserCRS();
//! Helper for getting number of user CRS already in db
long getRecordCount();
//! Helper for sql-safe value quoting
QString quotedValue( QString value );
void *mCRS;
bool loadFromDb( QString db, QString expression, QString value );
QString mValidationHint;
static CUSTOM_CRS_VALIDATION mCustomSrsValidation;
};
//! Output stream operator
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
|