This class represents a coordinate reference system (CRS). More...

#include <qgscoordinatereferencesystem.h>

Public Types
enum	CrsType { InternalCrsId , PostgisCrsId , EpsgCrsId }
	Enumeration of types of IDs accepted in createFromId() method. More...

Public Member Functions
	QgsCoordinateReferenceSystem ()
	Constructs an invalid CRS object.

	QgsCoordinateReferenceSystem (const QgsCoordinateReferenceSystem &srs)

	QgsCoordinateReferenceSystem (const QString &definition)
	Constructs a CRS object from a string definition using createFromString()

Q_DECL_DEPRECATED	QgsCoordinateReferenceSystem (long id, CrsType type=PostgisCrsId)
	Constructor.

	~QgsCoordinateReferenceSystem ()

QString	authid () const
	Returns the authority identifier for the CRS.

QList< Qgis::CrsAxisDirection >	axisOrdering () const
	Returns an ordered list of the axis directions reflecting the native axis order for the CRS.

QgsRectangle	bounds () const
	Returns the approximate bounds for the region the CRS is usable within.

QString	celestialBodyName () const
	Attempts to retrieve the name of the celestial body associated with the CRS (e.g.

double	coordinateEpoch () const
	Returns the coordinate epoch, as a decimal year.

Q_DECL_DEPRECATED bool	createFromId (long id, CrsType type=PostgisCrsId)
	Sets this CRS by lookup of the given ID in the CRS database.

bool	createFromOgcWmsCrs (const QString &crs)
	Sets this CRS to the given OGC WMS-format Coordinate Reference Systems.

bool	createFromProj (const QString &projString, bool identify=true)
	Sets this CRS by passing it a PROJ style formatted string.

Q_DECL_DEPRECATED bool	createFromProj4 (const QString &projString)
	Sets this CRS by passing it a PROJ style formatted string.

bool	createFromProjObject (PJ *object)
	Sets this CRS by passing it a PROJ PJ object, corresponding to a PROJ CRS object.

Q_DECL_DEPRECATED bool	createFromSrid (long srid)
	Sets this CRS by lookup of the given PostGIS SRID in the CRS database.

bool	createFromSrsId (long srsId)
	Sets this CRS by lookup of internal QGIS CRS ID in the CRS database.

bool	createFromString (const QString &definition)
	Set up this CRS from a string definition.

bool	createFromUserInput (const QString &definition)
	Set up this CRS from various text formats.

bool	createFromWkt (const QString &wkt)
	Sets this CRS using a WKT definition.

QgsDatumEnsemble	datumEnsemble () const
	Attempts to retrieve datum ensemble details from the CRS.

QString	description () const
	Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94".

QString	ellipsoidAcronym () const
	Returns the ellipsoid acronym for the ellipsoid used by the CRS.

QgsProjectionFactors	factors (const QgsPoint &point) const
	Calculate various cartographic properties, such as scale factors, angular distortion and meridian convergence for the CRS at the given geodetic point (in geographic coordinates).

Q_DECL_DEPRECATED long	findMatchingProj ()
	Walks the CRS databases (both system and user database) trying to match stored PROJ string to a database entry in order to fill in further pieces of information about CRS.

QString	geographicCrsAuthId () const
	Returns auth id of related geographic CRS.

bool	hasAxisInverted () const
	Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/latitude).

bool	hasVerticalAxis () const
	Returns `true` if the CRS has a vertical axis.

QgsCoordinateReferenceSystem	horizontalCrs () const
	Returns the horizontal CRS associated with this CRS object.

bool	isDeprecated () const
	Returns `true` if the CRS is considered deprecated.

bool	isDynamic () const
	Returns `true` if the CRS is a dynamic CRS.

bool	isGeographic () const
	Returns whether the CRS is a geographic CRS (using lat/lon coordinates)

bool	isValid () const
	Returns whether this CRS is correctly initialized and usable.

Qgis::DistanceUnit	mapUnits () const
	Returns the units for the projection used by the CRS.

Qgis::CrsDefinitionFormat	nativeFormat () const
	Returns the native format for the CRS definition.

QgsProjOperation	operation () const
	Returns information about the PROJ operation associated with the coordinate reference system, for example the projection method used by the CRS.

	operator QVariant () const
	Allows direct construction of QVariants from QgsCoordinateReferenceSystem.

bool	operator!= (const QgsCoordinateReferenceSystem &srs) const

QgsCoordinateReferenceSystem &	operator= (const QgsCoordinateReferenceSystem &srs)

bool	operator== (const QgsCoordinateReferenceSystem &srs) const

long	postgisSrid () const
	Returns PostGIS SRID for the CRS.

QString	projectionAcronym () const
	Returns the projection acronym for the projection used by the CRS.

PJ *	projObject () const
	Returns the underlying PROJ PJ object corresponding to the CRS, or `nullptr` if the CRS is invalid.

bool	readXml (const QDomNode &node)
	Restores state from the given DOM node.

long	saveAsUserCrs (const QString &name, Qgis::CrsDefinitionFormat nativeFormat=Qgis::CrsDefinitionFormat::Wkt)
	Saves the CRS as a new custom ("USER") CRS.

void	setCoordinateEpoch (double epoch)
	Sets the coordinate epoch, as a decimal year.

void	setNativeFormat (Qgis::CrsDefinitionFormat format)
	Sets the native format for the CRS definition.

void	setValidationHint (const QString &html)
	Set user hint for validation.

long	srsid () const
	Returns the internal CRS ID, if available.

QgsCoordinateReferenceSystem	toGeographicCrs () const
	Returns the geographic CRS associated with this CRS object.

QString	toOgcUri () const
	Returns the crs as OGC URI (format: http://www.opengis.net/def/crs/OGC/1.3/CRS84) Returns an empty string on failure.

QString	toOgcUrn () const
	Returns the crs as OGC URN (format: urn:ogc:def:crs:OGC:1.3:CRS84) Returns an empty string on failure.

QString	toProj () const
	Returns a Proj string representation of this CRS.

Q_DECL_DEPRECATED QString	toProj4 () const
	Returns a Proj string representation of this CRS.

QString	toWkt (Qgis::CrsWktVariant variant=Qgis::CrsWktVariant::Wkt1Gdal, bool multiline=false, int indentationWidth=4) const
	Returns a WKT representation of this CRS.

Qgis::CrsType	type () const
	Returns the type of the CRS.

void	updateDefinition ()
	Updates the definition and parameters of the coordinate reference system to their latest values.

QString	userFriendlyIdentifier (Qgis::CrsIdentifierType type=Qgis::CrsIdentifierType::MediumString) const
	Returns a user friendly identifier for the CRS.

void	validate ()
	Perform some validation on this CRS.

QString	validationHint () const
	Gets user hint for validation.

QgsCoordinateReferenceSystem	verticalCrs () const
	Returns the vertical CRS associated with this CRS object.

bool	writeXml (QDomNode &node, QDomDocument &doc) const
	Stores state to the given Dom node in the given document.

Static Public Member Functions
static Q_DECL_DEPRECATED void	clearRecentCoordinateReferenceSystems ()
	Cleans the list of recently used CRS.

static QgsCoordinateReferenceSystem	createCompoundCrs (const QgsCoordinateReferenceSystem &horizontalCrs, const QgsCoordinateReferenceSystem &verticalCrs, QString &error)
	Given a horizontal and vertical CRS, attempts to create a compound CRS from them.

static CUSTOM_CRS_VALIDATION	customCrsValidation ()
	Gets custom function.

static Q_INVOKABLE QgsCoordinateReferenceSystem	fromEpsgId (long epsg)
	Creates a CRS from a given EPSG ID.

static QgsCoordinateReferenceSystem	fromOgcWmsCrs (const QString &ogcCrs)
	Creates a CRS from a given OGC WMS-format Coordinate Reference System string.

static QgsCoordinateReferenceSystem	fromProj (const QString &proj)
	Creates a CRS from a proj style formatted string.

static Q_DECL_DEPRECATED QgsCoordinateReferenceSystem	fromProj4 (const QString &proj4)
	Creates a CRS from a proj style formatted string.

static QgsCoordinateReferenceSystem	fromProjObject (PJ *object)
	Constructs a QgsCoordinateReferenceSystem from a PROJ PJ object.

static QgsCoordinateReferenceSystem	fromSrsId (long srsId)
	Creates a CRS from a specified QGIS SRS ID.

static QgsCoordinateReferenceSystem	fromWkt (const QString &wkt)
	Creates a CRS from a WKT spatial ref sys definition string.

static void	invalidateCache (bool disableCache=false)
	Clears the internal cache used to initialize QgsCoordinateReferenceSystem objects.

static Q_DECL_DEPRECATED void	pushRecentCoordinateReferenceSystem (const QgsCoordinateReferenceSystem &crs)
	Pushes a recently used CRS to the top of the recent CRS list.

static Q_DECL_DEPRECATED QList< QgsCoordinateReferenceSystem >	recentCoordinateReferenceSystems ()
	Returns a list of recently used CRS.

static Q_DECL_DEPRECATED QStringList	recentProjections ()
	Returns a list of recently used projections.

static Q_DECL_DEPRECATED void	removeRecentCoordinateReferenceSystem (const QgsCoordinateReferenceSystem &crs)
	Removes a CRS from the list of recently used CRS.

static void	setCustomCrsValidation (CUSTOM_CRS_VALIDATION f)
	Sets custom function to force valid CRS.

static Q_DECL_DEPRECATED void	setupESRIWktFix ()
	Make sure that ESRI WKT import is done properly.

static int	syncDatabase ()
	Update proj.4 parameters in our database from proj.4.

static QList< long >	validSrsIds ()
	Returns a list of all valid SRS IDs present in the CRS database.

Properties
QString	authid

QString	description

bool	isGeographic

Qgis::DistanceUnit	mapUnits

Friends
bool CORE_EXPORT	operator< (const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2)

bool CORE_EXPORT	operator<= (const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2)

bool CORE_EXPORT	operator> (const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2)

bool CORE_EXPORT	operator>= (const QgsCoordinateReferenceSystem &c1, const QgsCoordinateReferenceSystem &c2)

class	QgsCoordinateReferenceSystemRegistry

class	QgsProjContext

class	TestQgsCoordinateReferenceSystem

Detailed Description

This class represents a coordinate reference system (CRS).

Coordinate reference system object defines a specific map projection, as well as transformations between different coordinate reference systems. There are various ways how a CRS can be defined: using well-known text (WKT), PROJ string or combination of authority and code (e.g. EPSG:4326). QGIS comes with its internal database of coordinate reference systems (stored in SQLite) that allows lookups of CRS and seamless conversions between the various definitions.

Most commonly one comes across two types of coordinate systems:

Geographic coordinate systems: based on a geodetic datum, normally with coordinates being latitude/longitude in degrees. The most common one is World Geodetic System 84 (WGS84).
Projected coordinate systems: based on a geodetic datum with coordinates projected to a plane, typically using meters or feet as units. Common projected coordinate systems are Universal Transverse Mercator or Albers Equal Area.

Internally QGIS uses proj library for all the math behind coordinate transformations, so in case of any troubles with projections it is best to examine the PROJ representation within the object, as that is the representation that will be ultimately used.

Methods that allow inspection of CRS instances include isValid(), authid(), description(), toWkt(), toProj(), mapUnits() and others. Creation of CRS instances is further described in Object Construction and Copying section below. Transformations between coordinate reference systems are done using QgsCoordinateTransform class.

For example, the following code will create and inspect "British national grid" CRS:

crs = QgsCoordinateReferenceSystem("EPSG:27700")
if crs.isValid():
    print("CRS Description: {}".format(crs.description()))
    print("CRS PROJ text: {}".format(crs.toProj()))
else:
    print("Invalid CRS!")

This will produce the following output:

CRS Description: OSGB 1936 / British National Grid

CRS PROJ text: +proj=tmerc +lat_0=49 +lon_0=-2 +k=0.9996012717 +x_0=400000 +y_0=-100000 [output trimmed]

CRS Definition Formats

This section gives an overview of various supported CRS definition formats:

Authority and Code: Also referred to as OGC WMS format within QGIS as they have been widely used in OGC standards. These are encoded as <auth>:<code>, for example EPSG:4326 refers to WGS84 system. EPSG is the most commonly used authority that covers a wide range of coordinate systems around the world.

An extended variant of this format is OGC URN. Syntax of URN for CRS definition is urn:ogc:def:crs:<auth>:[<version>]:<code>. This class can also parse URNs (versions are currently ignored). For example, WGS84 may be encoded as urn:ogc:def:crs:OGC:1.3:CRS84.

QGIS adds support for "USER" authority that refers to IDs used internally in QGIS. This variant is best avoided or used with caution as the IDs are not permanent and they refer to different CRS on different machines or user profiles.

See also
authid()

createFromOgcWmsCrs()
PROJ string: This is a string consisting of a series of key/value pairs in the following format: +param1=value1 +param2=value2 [...]. This is the format natively used by the underlying proj library. For example, the definition of WGS84 looks like this:

+proj=longlat +datum=WGS84 +no_defs

See also
toProj()

createFromProj()
Well-known text (WKT): Defined by Open Geospatial Consortium (OGC), this is another common format to define CRS. For WGS84 the OGC WKT definition is the following:

GEOGCS["WGS 84",

DATUM["WGS_1984",

SPHEROID["WGS 84",6378137,298.257223563,AUTHORITY["EPSG","7030"]],

AUTHORITY["EPSG","6326"]],

PRIMEM["Greenwich",0,AUTHORITY["EPSG","8901"]],

UNIT["degree",0.0174532925199433,AUTHORITY["EPSG","9122"]],

AUTHORITY["EPSG","4326"]]

See also
toWkt()

createFromWkt()

CRS Database and Custom CRS

The database of CRS shipped with QGIS is stored in a SQLite database (see QgsApplication::srsDatabaseFilePath()) and it is based on the data files maintained by GDAL project (a variety of .csv and .wkt files).

Sometimes it happens that users need to use a CRS definition that is not well known or that has been only created with a specific purpose (and thus its definition is not available in our database of CRS). Whenever a new CRS definition is seen, it will be added to the local database (in user's home directory, see QgsApplication::qgisUserDatabaseFilePath()). QGIS also features a GUI for management of local custom CRS definitions.

There are therefore two databases: one for shipped CRS definitions and one for custom CRS definitions. Custom CRS have internal IDs (accessible with srsid()) greater or equal to USER_CRS_START_ID. The local CRS databases should never be accessed directly with SQLite functions, instead you should use QgsCoordinateReferenceSystem API for CRS lookups and for managements of custom CRS.

Validation

In some cases (most prominently when loading a map layer), QGIS will try to ensure that the given map layer CRS is valid using validate() call. If not, a custom validation function will be called - such function may for example show a GUI for manual CRS selection. The validation function is configured using setCustomCrsValidation(). If validation fails or no validation function is set, the default CRS is assigned (WGS84). QGIS application registers its validation function that will act according to user's settings (either show CRS selector dialog or use project/custom CRS).

Object Construction and Copying

The easiest way of creating CRS instances is to use QgsCoordinateReferenceSystem(const QString&) constructor that automatically recognizes definition format from the given string.

Creation of CRS object involves some queries in a local SQLite database, which may be potentially expensive. Consequently, CRS creation methods use an internal cache to avoid unnecessary database lookups. If the CRS database is modified, then it is necessary to call invalidateCache() to ensure that outdated records are not being returned from the cache.

Since QGIS 2.16 QgsCoordinateReferenceSystem objects are implicitly shared.

Caveats

There are two different flavors of WKT: one is defined by OGC, the other is the standard used by ESRI. They look very similar, but they are not the same. QGIS is able to consume both flavors.

See also: QgsCoordinateTransform

Definition at line 211 of file qgscoordinatereferencesystem.h.

Member Enumeration Documentation

◆ CrsType

enum QgsCoordinateReferenceSystem::CrsType

Enumeration of types of IDs accepted in createFromId() method.

Enumerator
InternalCrsId	Internal ID used by QGIS in the local SQLite database.
PostgisCrsId	SRID used in PostGIS. DEPRECATED – DO NOT USE.
EpsgCrsId	EPSG code.

Definition at line 223 of file qgscoordinatereferencesystem.h.

Constructor & Destructor Documentation

◆ QgsCoordinateReferenceSystem() [1/4]

QgsCoordinateReferenceSystem::QgsCoordinateReferenceSystem ( )

Constructs an invalid CRS object.

Definition at line 106 of file qgscoordinatereferencesystem.cpp.

◆ ~QgsCoordinateReferenceSystem()

QgsCoordinateReferenceSystem::~QgsCoordinateReferenceSystem ( )

Definition at line 269 of file qgscoordinatereferencesystem.cpp.

◆ QgsCoordinateReferenceSystem() [2/4]

QgsCoordinateReferenceSystem::QgsCoordinateReferenceSystem ( const QString & definition )

explicit

Constructs a CRS object from a string definition using createFromString()

It supports the following formats:

"EPSG:<code>" - handled with createFromOgcWms()
"POSTGIS:<srid>" - handled with createFromSrid()
"INTERNAL:<srsid>" - handled with createFromSrsId()
"PROJ:<proj>" - handled with createFromProj()
"WKT:<wkt>" - handled with createFromWkt()

If no prefix is specified, WKT definition is assumed.

Parameters

definition A String containing a coordinate reference system definition.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

See also: createFromString()

Definition at line 113 of file qgscoordinatereferencesystem.cpp.

◆ QgsCoordinateReferenceSystem() [3/4]

QgsCoordinateReferenceSystem::QgsCoordinateReferenceSystem	(	long	id,
		CrsType	type = `PostgisCrsId`
	)

explicit

Constructor.

A CRS object using a PostGIS SRID, an EPSG code or an internal QGIS CRS ID.

Note: We encourage you to use EPSG code or WKT to describe CRSes in your code wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile, and proj strings are a lossy format.

Parameters

id	The ID valid for the chosen CRS ID type
type	One of the types described in CrsType

Deprecated:: QGIS 3.10. We encourage you to use EPSG codes or WKT to describe CRSes in your code wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile, and Proj strings are a lossy format.

Definition at line 119 of file qgscoordinatereferencesystem.cpp.

◆ QgsCoordinateReferenceSystem() [4/4]

QgsCoordinateReferenceSystem::QgsCoordinateReferenceSystem ( const QgsCoordinateReferenceSystem & srs )

Definition at line 127 of file qgscoordinatereferencesystem.cpp.

Member Function Documentation

◆ authid()

QString QgsCoordinateReferenceSystem::authid ( ) const

Returns the authority identifier for the CRS.

The identifier includes both the authority (e.g., EPSG) and the CRS number (e.g., 4326). This is the best method to use when showing a very short CRS identifier to a user, e.g., "EPSG:4326".

If CRS object is a custom CRS (not found in database), the method will return internal QGIS CRS ID with "QGIS" authority, for example "QGIS:100005"

Returns: the authority identifier for this CRS

See also: description()

Definition at line 1229 of file qgscoordinatereferencesystem.cpp.

◆ axisOrdering()

QList< Qgis::CrsAxisDirection > QgsCoordinateReferenceSystem::axisOrdering ( ) const

Returns an ordered list of the axis directions reflecting the native axis order for the CRS.

Since: QGIS 3.26

Definition at line 835 of file qgscoordinatereferencesystem.cpp.

◆ bounds()

QgsRectangle QgsCoordinateReferenceSystem::bounds ( ) const

Returns the approximate bounds for the region the CRS is usable within.

The returned bounds represent the latitude and longitude extent for the projection in the WGS 84 CRS.

Definition at line 1580 of file qgscoordinatereferencesystem.cpp.

◆ celestialBodyName()

QString QgsCoordinateReferenceSystem::celestialBodyName ( ) const

Attempts to retrieve the name of the celestial body associated with the CRS (e.g.

"Earth").

Warning: This method requires PROJ 8.1 or later

Exceptions

QgsNotSupportedException on QGIS builds based on PROJ 8.0 or earlier.

Since: QGIS 3.20

Definition at line 1428 of file qgscoordinatereferencesystem.cpp.

◆ clearRecentCoordinateReferenceSystems()

void QgsCoordinateReferenceSystem::clearRecentCoordinateReferenceSystems ( )

static

Cleans the list of recently used CRS.

Deprecated:: QGIS 3.36. Use QgsApplication::coordinateReferenceSystemRegistry()->clearRecent() instead.

Definition at line 3297 of file qgscoordinatereferencesystem.cpp.

◆ coordinateEpoch()

double QgsCoordinateReferenceSystem::coordinateEpoch ( ) const

Returns the coordinate epoch, as a decimal year.

In a dynamic CRS, coordinates of a point on the surface of the Earth may change with time. To be unambiguous the coordinates must always be qualified with the epoch at which they are valid. The coordinate epoch is not necessarily the epoch at which the observation was collected.

Pedantically the coordinate epoch of an observation belongs to the observation, and not to the CRS, however it is often more practical to bind it to the CRS. The coordinate epoch should be specified for dynamic CRS (see isDynamic()).

Warning: The QgsCoordinateTransform class can perform time-dependent transformations between a static and dynamic CRS based on either the source or destination CRS coordinate epoch, however dynamic CRS to dynamic CRS transformations are not currently supported.

Returns: Coordinate epoch as decimal year (e.g. 2021.3), or NaN if not set, or relevant.

See also: setCoordinateEpoch()

Since: QGIS 3.20

Definition at line 1455 of file qgscoordinatereferencesystem.cpp.

◆ createCompoundCrs()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::createCompoundCrs	(	const QgsCoordinateReferenceSystem &	horizontalCrs,
		const QgsCoordinateReferenceSystem &	verticalCrs,
		QString &	error
	)

static

Given a horizontal and vertical CRS, attempts to create a compound CRS from them.

Returns an invalid CRS if the inputs are not suitable for a compound CRS, or the compound CRS could not be created for the combination.

Parameters

horizontalCrs	horizontal component for CRS
verticalCrs	vertical component for CRS
error	will be set to a descriptive error if the compound CRS could not be created

Returns: compound CRS if it was possible to create one, or an invalid CRS if not

Since: QGIS 3.38

Definition at line 245 of file qgscoordinatereferencesystem.cpp.

◆ createFromId()

bool QgsCoordinateReferenceSystem::createFromId	(	long	id,
		CrsType	type = `PostgisCrsId`
	)

Sets this CRS by lookup of the given ID in the CRS database.

Returns: true on success else false

Deprecated:: QGIS 3.10. We encourage you to use EPSG code or WKT to describe CRSes in your code wherever possible. Internal QGIS CRS IDs are not guaranteed to be permanent / involatile, and Proj strings are a lossy format.

Definition at line 273 of file qgscoordinatereferencesystem.cpp.

◆ createFromOgcWmsCrs()

bool QgsCoordinateReferenceSystem::createFromOgcWmsCrs ( const QString & crs )

Sets this CRS to the given OGC WMS-format Coordinate Reference Systems.

Accepts both "<auth>:<code>" format and OGC URN "urn:ogc:def:crs:<auth>:[<version>]:<code>". It also recognizes "QGIS", "USER", "CUSTOM" authorities, which all have the same meaning and refer to QGIS internal CRS IDs.

Returns: true on success else false

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

See also: fromOgcWmsCrs()

Definition at line 412 of file qgscoordinatereferencesystem.cpp.

◆ createFromProj()

bool QgsCoordinateReferenceSystem::createFromProj	(	const QString &	projString,
		bool	identify = `true`
	)

Sets this CRS by passing it a PROJ style formatted string.

The string will be parsed and the projection and ellipsoid members set and the remainder of the Proj 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.db sqlite database.

We try to match the Proj string to internal QGIS CRS ID using the following logic:

ask the Proj library to identify the CRS to a standard registered CRS (e.g. EPSG codes)
if no match is found, compare the CRS to all user CRSes, using the Proj library to determine CRS equivalence (hence making the match parameter order insensitive)
if none of the above match, use the Proj string to create the CRS and do not associated an internal CRS ID to it.

Parameters

projString	A Proj format string
identify	if `false`, no attempts will be made to match the proj string against known CRS authorities. This is much faster, but should only ever be used when it is known in advance that the definition does not correspond to a known or user CRS. This argument is not available in Python.

Returns: true on success else false

Note: Some members may be left blank if no match can be found in CRS database.; This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

See also: fromProj()

Since: QGIS 3.10.3

Definition at line 1021 of file qgscoordinatereferencesystem.cpp.

◆ createFromProj4()

bool QgsCoordinateReferenceSystem::createFromProj4 ( const QString & projString )

Sets this CRS by passing it a PROJ style formatted string.

The string will be parsed and the projection and ellipsoid members set and the remainder of the Proj 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.db sqlite database.

We try to match the Proj string to internal QGIS CRS ID using the following logic:

ask the Proj library to identify the CRS to a standard registered CRS (e.g. EPSG codes)
if no match is found, compare the CRS to all user CRSes, using the Proj library to determine CRS equivalence (hence making the match parameter order insensitive)
if none of the above match, use the Proj string to create the CRS and do not associated an internal CRS ID to it.

Parameters

projString A Proj format string

Returns: true on success else false

Note: Some members may be left blank if no match can be found in CRS database.; This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

See also: fromProj()

Deprecated:: QGIS 3.10. Use createFromProj() instead.

Definition at line 1016 of file qgscoordinatereferencesystem.cpp.

◆ createFromProjObject()

bool QgsCoordinateReferenceSystem::createFromProjObject ( PJ * object )

Sets this CRS by passing it a PROJ PJ object, corresponding to a PROJ CRS object.

Ownership of object is not transferred.

Note: Not available in Python bindings

Since: QGIS 3.24

Definition at line 3210 of file qgscoordinatereferencesystem.cpp.

◆ createFromSrid()

bool QgsCoordinateReferenceSystem::createFromSrid ( long srid )

Sets this CRS by lookup of the given PostGIS SRID in the CRS database.

Parameters

srid	The PostGIS SRID for the desired spatial reference system.

Returns: true on success else false

Deprecated:: QGIS 3.10. Use alternative methods for SRS construction instead – this method was specifically created for use by the postgres provider alone, and using it elsewhere will lead to subtle bugs.

Definition at line 543 of file qgscoordinatereferencesystem.cpp.

◆ createFromSrsId()

bool QgsCoordinateReferenceSystem::createFromSrsId ( long srsId )

Sets this CRS by lookup of internal QGIS CRS ID in the CRS database.

If the srsid is < USER_CRS_START_ID, system CRS database is used, otherwise user's local CRS database from home directory is used.

Parameters

srsId The internal QGIS CRS ID for the desired spatial reference system.

Returns: true on success else false

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

See also: fromSrsId()

Warning: This method is highly discouraged, and CRS objects should instead be constructed using auth:id codes or WKT strings

Definition at line 586 of file qgscoordinatereferencesystem.cpp.

◆ createFromString()

bool QgsCoordinateReferenceSystem::createFromString ( const QString & definition )

Set up this CRS from a string definition.

It supports the following formats:

"EPSG:<code>" - handled with createFromOgcWms()
"POSTGIS:<srid>" - handled with createFromSrid()
"INTERNAL:<srsid>" - handled with createFromSrsId()
"PROJ:<proj>" - handled with createFromProj()
"WKT:<wkt>" - handled with createFromWkt()

If no prefix is specified, WKT definition is assumed.

Parameters

definition A String containing a coordinate reference system definition.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Returns: true on success else false

Definition at line 296 of file qgscoordinatereferencesystem.cpp.

◆ createFromUserInput()

bool QgsCoordinateReferenceSystem::createFromUserInput ( const QString & definition )

Set up this CRS from various text formats.

Valid formats: WKT string, "EPSG:n", "EPSGA:n", "AUTO:proj_id,unit_id,lon0,lat0", "urn:ogc:def:crs:EPSG::n", PROJ string, filename (with WKT, XML or PROJ string), well known name (such as NAD27, NAD83, WGS84 or WGS72), ESRI::[WKT string] (directly or in a file), "IGNF:xxx"

For more details on supported formats see OGRSpatialReference::SetFromUserInput() ( https://gdal.org/doxygen/classOGRSpatialReference.html#aec3c6a49533fe457ddc763d699ff8796 )

Parameters

definition A String containing a coordinate reference system definition.

Returns: true on success else false

Note: this function generates a WKT string using OSRSetFromUserInput() and passes it to createFromWkt() function.; This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Definition at line 374 of file qgscoordinatereferencesystem.cpp.

◆ createFromWkt()

bool QgsCoordinateReferenceSystem::createFromWkt ( const QString & wkt )

Sets this CRS using a WKT definition.

If EPSG code of the WKT definition can be determined, it is extracted and createFromOgcWmsCrs() is used to initialize the object.

Parameters

wkt	The WKT for the desired spatial reference system.

Returns: true on success else false

Note: Some members may be left blank if no match can be found in CRS database.; This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

See also: fromWkt()

Definition at line 933 of file qgscoordinatereferencesystem.cpp.

◆ customCrsValidation()

CUSTOM_CRS_VALIDATION QgsCoordinateReferenceSystem::customCrsValidation ( )

static

Gets custom function.

Note: not available in Python bindings

Definition at line 2373 of file qgscoordinatereferencesystem.cpp.

◆ datumEnsemble()

QgsDatumEnsemble QgsCoordinateReferenceSystem::datumEnsemble ( ) const

Attempts to retrieve datum ensemble details from the CRS.

If the CRS does not use a datum ensemble then an invalid QgsDatumEnsemble will be returned.

Note: In the case of a compound crs, this method will always return the datum ensemble for the horizontal component.

Warning: This method requires PROJ 8.0 or later

Exceptions

QgsNotSupportedException on QGIS builds based on PROJ 7 or earlier.

Since: QGIS 3.20

Definition at line 1460 of file qgscoordinatereferencesystem.cpp.

◆ description()

QString QgsCoordinateReferenceSystem::description ( ) const

Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94".

Note: an empty string will be returned if the description is not available for the CRS

See also: authid(); userFriendlyIdentifier()

Definition at line 1234 of file qgscoordinatereferencesystem.cpp.

◆ ellipsoidAcronym()

QString QgsCoordinateReferenceSystem::ellipsoidAcronym ( ) const

Returns the ellipsoid acronym for the ellipsoid used by the CRS.

Returns: the official authority:code identifier for the ellipsoid, or PARAMETER:MAJOR:MINOR for custom ellipsoids

Note: an empty string will be returned if the ellipsoidAcronym is not available for the CRS

See also: projectionAcronym()

Definition at line 1285 of file qgscoordinatereferencesystem.cpp.

◆ factors()

QgsProjectionFactors QgsCoordinateReferenceSystem::factors ( const QgsPoint & point ) const

Calculate various cartographic properties, such as scale factors, angular distortion and meridian convergence for the CRS at the given geodetic point (in geographic coordinates).

Depending on the underlying projection values will be calculated either numerically (default) or analytically. The function also calculates the partial derivatives of the given coordinate.

Note: Internally uses the proj library proj_factors API to calculate the factors.

Since: QGIS 3.20

Definition at line 1506 of file qgscoordinatereferencesystem.cpp.

◆ findMatchingProj()

long QgsCoordinateReferenceSystem::findMatchingProj ( )

Walks the CRS databases (both system and user database) trying to match stored PROJ string to a database entry in order to fill in further pieces of information about CRS.

Note: The ellipsoid and projection acronyms must be set as well as the proj string!

Returns: long the SrsId of the matched CRS, zero if no match was found

Deprecated:: QGIS 3.10. Not used in Proj >= 6 based builds.

Definition at line 1953 of file qgscoordinatereferencesystem.cpp.

◆ fromEpsgId()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromEpsgId ( long epsg )

static

Creates a CRS from a given EPSG ID.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Parameters

epsg	epsg CRS ID

Returns: matching CRS, or an invalid CRS if string could not be matched

Definition at line 205 of file qgscoordinatereferencesystem.cpp.

◆ fromOgcWmsCrs()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromOgcWmsCrs ( const QString & ogcCrs )

static

Creates a CRS from a given OGC WMS-format Coordinate Reference System string.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Parameters

ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326"

Returns: matching CRS, or an invalid CRS if string could not be matched

See also: createFromOgcWmsCrs()

Definition at line 198 of file qgscoordinatereferencesystem.cpp.

◆ fromProj()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromProj ( const QString & proj )

static

Creates a CRS from a proj style formatted string.

Parameters

proj	proj format string

Returns: matching CRS, or an invalid CRS if string could not be matched

See also: createFromProj()

Since: QGIS 3.10.3

Definition at line 224 of file qgscoordinatereferencesystem.cpp.

◆ fromProj4()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromProj4 ( const QString & proj4 )

static

Creates a CRS from a proj style formatted string.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Returns: matching CRS, or an invalid CRS if string could not be matched

See also: createFromProj()

Deprecated:: QGIS 3.10. Use fromProj() instead.

Definition at line 219 of file qgscoordinatereferencesystem.cpp.

◆ fromProjObject()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromProjObject ( PJ * object )

static

Constructs a QgsCoordinateReferenceSystem from a PROJ PJ object.

The object must correspond to a PROJ CRS object.

Ownership of object is not transferred.

Note: Not available in Python bindings

Since: QGIS 3.24

Definition at line 3203 of file qgscoordinatereferencesystem.cpp.

◆ fromSrsId()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromSrsId ( long srsId )

static

Creates a CRS from a specified QGIS SRS ID.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Parameters

srsId internal QGIS SRS ID

Returns: matching CRS, or an invalid CRS if ID could not be found

See also: createFromSrsId(); validSrsIds()

Definition at line 238 of file qgscoordinatereferencesystem.cpp.

◆ fromWkt()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::fromWkt ( const QString & wkt )

static

Creates a CRS from a WKT spatial ref sys definition string.

Note: This method uses an internal cache to speed up creation of multiple CRS with the same definition. Call invalidateCache() to clear the cache.

Parameters

wkt	WKT for the desired spatial reference system.

Returns: matching CRS, or an invalid CRS if string could not be matched

See also: createFromWkt()

Definition at line 231 of file qgscoordinatereferencesystem.cpp.

◆ geographicCrsAuthId()

QString QgsCoordinateReferenceSystem::geographicCrsAuthId ( ) const

Returns auth id of related geographic CRS.

Definition at line 3181 of file qgscoordinatereferencesystem.cpp.

◆ hasAxisInverted()

bool QgsCoordinateReferenceSystem::hasAxisInverted ( ) const

Returns whether the axis order is inverted for the CRS compared to the order east/north (longitude/latitude).

E.g. with WMS 1.3 the axis order for EPSG:4326 is north/east (latitude/longitude), i.e. inverted.

Returns: true if CRS axis is inverted

See also: axisOrdering()

Definition at line 824 of file qgscoordinatereferencesystem.cpp.

◆ hasVerticalAxis()

bool QgsCoordinateReferenceSystem::hasVerticalAxis ( ) const

Returns true if the CRS has a vertical axis.

See also: verticalCrs()

Since: QGIS 3.38

Definition at line 3172 of file qgscoordinatereferencesystem.cpp.

◆ horizontalCrs()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::horizontalCrs ( ) const

Returns the horizontal CRS associated with this CRS object.

In the case of a compound CRS, this method will return just the horizontal CRS component.

An invalid CRS will be returned if the object does not contain a horizontal component.

See also: verticalCrs()

Since: QGIS 3.38

Definition at line 3106 of file qgscoordinatereferencesystem.cpp.

◆ invalidateCache()

void QgsCoordinateReferenceSystem::invalidateCache ( bool disableCache = false )

static

Clears the internal cache used to initialize QgsCoordinateReferenceSystem objects.

This should be called whenever the srs database has been modified in order to ensure that outdated CRS objects are not created.

If disableCache is true then the inbuilt cache will be completely disabled. This argument is for internal use only.

Definition at line 3302 of file qgscoordinatereferencesystem.cpp.

◆ isDeprecated()

bool QgsCoordinateReferenceSystem::isDeprecated ( ) const

Returns true if the CRS is considered deprecated.

Since: QGIS 3.36

Definition at line 1405 of file qgscoordinatereferencesystem.cpp.

◆ isDynamic()

bool QgsCoordinateReferenceSystem::isDynamic ( ) const

Returns true if the CRS is a dynamic CRS.

A dynamic CRS relies on a dynamic datum, that is a datum that is not plate-fixed.

Since: QGIS 3.20

Definition at line 1419 of file qgscoordinatereferencesystem.cpp.

◆ isGeographic()

bool QgsCoordinateReferenceSystem::isGeographic ( ) const

Returns whether the CRS is a geographic CRS (using lat/lon coordinates)

Returns: true if CRS is geographic, or false if it is a projected CRS

Definition at line 1414 of file qgscoordinatereferencesystem.cpp.

◆ isValid()

bool QgsCoordinateReferenceSystem::isValid ( ) const

Returns whether this CRS is correctly initialized and usable.

Definition at line 1011 of file qgscoordinatereferencesystem.cpp.

◆ mapUnits()

Qgis::DistanceUnit QgsCoordinateReferenceSystem::mapUnits ( ) const

Returns the units for the projection used by the CRS.

Note: In the case of a compound CRS, this method will always return the units for the horizontal component.

Definition at line 1572 of file qgscoordinatereferencesystem.cpp.

◆ nativeFormat()

Qgis::CrsDefinitionFormat QgsCoordinateReferenceSystem::nativeFormat ( ) const

Returns the native format for the CRS definition.

Note: This has no effect on the underlying definition of the CRS, rather it controls what format to use when displaying the CRS's definition to users.

See also: setNativeFormat()

Since: QGIS 3.24

Definition at line 2420 of file qgscoordinatereferencesystem.cpp.

◆ operation()

QgsProjOperation QgsCoordinateReferenceSystem::operation ( ) const

Returns information about the PROJ operation associated with the coordinate reference system, for example the projection method used by the CRS.

Since: QGIS 3.20

Definition at line 1545 of file qgscoordinatereferencesystem.cpp.

◆ operator QVariant()

QgsCoordinateReferenceSystem::operator QVariant ( ) const

inline

Allows direct construction of QVariants from QgsCoordinateReferenceSystem.

Definition at line 277 of file qgscoordinatereferencesystem.h.

◆ operator!=()

bool QgsCoordinateReferenceSystem::operator!= ( const QgsCoordinateReferenceSystem & srs ) const

Definition at line 2056 of file qgscoordinatereferencesystem.cpp.

◆ operator=()

QgsCoordinateReferenceSystem & QgsCoordinateReferenceSystem::operator= ( const QgsCoordinateReferenceSystem & srs )

Definition at line 134 of file qgscoordinatereferencesystem.cpp.

◆ operator==()

bool QgsCoordinateReferenceSystem::operator== ( const QgsCoordinateReferenceSystem & srs ) const

Definition at line 2029 of file qgscoordinatereferencesystem.cpp.

◆ postgisSrid()

long QgsCoordinateReferenceSystem::postgisSrid ( ) const

Returns PostGIS SRID for the CRS.

Returns: the PostGIS spatial_ref_sys identifier for this CRS (defaults to 0)

Definition at line 1224 of file qgscoordinatereferencesystem.cpp.

◆ projectionAcronym()

QString QgsCoordinateReferenceSystem::projectionAcronym ( ) const

Returns the projection acronym for the projection used by the CRS.

Returns: the official Proj acronym for the projection family

Note: an empty string will be returned if the projectionAcronym is not available for the CRS

See also: ellipsoidAcronym()

Definition at line 1273 of file qgscoordinatereferencesystem.cpp.

◆ projObject()

PJ * QgsCoordinateReferenceSystem::projObject ( ) const

Returns the underlying PROJ PJ object corresponding to the CRS, or nullptr if the CRS is invalid.

This object is only valid for the lifetime of the QgsCoordinateReferenceSystem.

Note: Not available in Python bindings.

Since: QGIS 3.8

Definition at line 3198 of file qgscoordinatereferencesystem.cpp.

◆ pushRecentCoordinateReferenceSystem()

void QgsCoordinateReferenceSystem::pushRecentCoordinateReferenceSystem ( const QgsCoordinateReferenceSystem & crs )

static

Pushes a recently used CRS to the top of the recent CRS list.

Deprecated:: QGIS 3.36. Use QgsApplication::coordinateReferenceSystemRegistry()->pushRecent() instead.

Definition at line 3287 of file qgscoordinatereferencesystem.cpp.

◆ readXml()

bool QgsCoordinateReferenceSystem::readXml ( const QDomNode & node )

Restores state from the given DOM node.

If it fails or if the node is empty, a default empty CRS will be returned.

Parameters

node	The node from which state will be restored

Returns: bool true on success, false on failure

Definition at line 2111 of file qgscoordinatereferencesystem.cpp.

◆ recentCoordinateReferenceSystems()

QList< QgsCoordinateReferenceSystem > QgsCoordinateReferenceSystem::recentCoordinateReferenceSystems ( )

static

Returns a list of recently used CRS.

Deprecated:: QGIS 3.36. Use QgsApplication::coordinateReferenceSystemRegistry()->recentCrs() instead.

Definition at line 3282 of file qgscoordinatereferencesystem.cpp.

◆ recentProjections()

QStringList QgsCoordinateReferenceSystem::recentProjections ( )

static

Returns a list of recently used projections.

Returns: list of srsid for recently used projections

Deprecated:: QGIS 3.10. Use QgsApplication::coordinateReferenceSystemRegistry()->recentCrs() instead.

Definition at line 3270 of file qgscoordinatereferencesystem.cpp.

◆ removeRecentCoordinateReferenceSystem()

void QgsCoordinateReferenceSystem::removeRecentCoordinateReferenceSystem ( const QgsCoordinateReferenceSystem & crs )

static

Removes a CRS from the list of recently used CRS.

Deprecated:: QGIS 3.36. Use QgsApplication::coordinateReferenceSystemRegistry()->removeRecent() instead.

Definition at line 3292 of file qgscoordinatereferencesystem.cpp.

◆ saveAsUserCrs()

long QgsCoordinateReferenceSystem::saveAsUserCrs	(	const QString &	name,
		Qgis::CrsDefinitionFormat	nativeFormat = `Qgis::CrsDefinitionFormat::Wkt`
	)

Saves the CRS as a new custom ("USER") CRS.

Returns the new CRS srsid(), or -1 if the CRS could not be saved.

The nativeFormat argument specifies the format to use when saving the CRS definition. FormatWkt is recommended as it is a lossless format.

Warning: Not all CRS definitions can be represented as a Proj string, so take care when using the FormatProj option.

Note: Since QGIS 3.18, internally this calls QgsCoordinateReferenceSystemRegistry::addUserCrs().

Definition at line 2410 of file qgscoordinatereferencesystem.cpp.

◆ setCoordinateEpoch()

void QgsCoordinateReferenceSystem::setCoordinateEpoch ( double epoch )

Sets the coordinate epoch, as a decimal year.

In a dynamic CRS (see isDynamic()), coordinates of a point on the surface of the Earth may change with time. To be unambiguous the coordinates must always be qualified with the epoch at which they are valid. The coordinate epoch is not necessarily the epoch at which the observation was collected.

Pedantically the coordinate epoch of an observation belongs to the observation, and not to the CRS, however it is often more practical to bind it to the CRS. The coordinate epoch should be specified for dynamic CRS (see isDynamic()).

Parameters

epoch Coordinate epoch as decimal year (e.g. 2021.3)

Warning: The QgsCoordinateTransform class can perform time-dependent transformations between a static and dynamic CRS based on either the source or destination CRS coordinate epoch, however dynamic CRS to dynamic CRS transformations are not currently supported.

See also: coordinateEpoch()

Since: QGIS 3.20

Definition at line 1443 of file qgscoordinatereferencesystem.cpp.

◆ setCustomCrsValidation()

void QgsCoordinateReferenceSystem::setCustomCrsValidation ( CUSTOM_CRS_VALIDATION f )

static

Sets custom function to force valid CRS.

Note: not available in Python bindings

Definition at line 2368 of file qgscoordinatereferencesystem.cpp.

◆ setNativeFormat()

void QgsCoordinateReferenceSystem::setNativeFormat ( Qgis::CrsDefinitionFormat format )

Sets the native format for the CRS definition.

Note: This has no effect on the underlying definition of the CRS, rather it controls what format to use when displaying the CRS's definition to users.

See also: nativeFormat()

Since: QGIS 3.24

Definition at line 2415 of file qgscoordinatereferencesystem.cpp.

◆ setupESRIWktFix()

void QgsCoordinateReferenceSystem::setupESRIWktFix ( )

static

Make sure that ESRI WKT import is done properly.

This is required for proper shapefile CRS import when using gdal>= 1.9.

Note: This function is called by createFromUserInput() and QgsOgrProvider::crs(), there is usually no need to call it from elsewhere.; This function sets CPL config option GDAL_FIX_ESRI_WKT to a proper value, unless it has been set by the user through the commandline or an environment variable. For more details refer to OGRSpatialReference::morphFromESRI() .

Deprecated:: QGIS 3.10. Not used on builds based on Proj version 6 or later.

Definition at line 391 of file qgscoordinatereferencesystem.cpp.

◆ setValidationHint()

void QgsCoordinateReferenceSystem::setValidationHint ( const QString & html )

Set user hint for validation.

Definition at line 2400 of file qgscoordinatereferencesystem.cpp.

◆ srsid()

long QgsCoordinateReferenceSystem::srsid ( ) const

Returns the internal CRS ID, if available.

Returns: the internal sqlite3 srs.db primary key for this CRS

Definition at line 1219 of file qgscoordinatereferencesystem.cpp.

◆ syncDatabase()

int QgsCoordinateReferenceSystem::syncDatabase ( )

static

Update proj.4 parameters in our database from proj.4.

Returns: number of updated CRS on success and negative number of failed updates in case of errors.

Note: This is used internally and should not be necessary to call in client code

Definition at line 2654 of file qgscoordinatereferencesystem.cpp.

◆ toGeographicCrs()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::toGeographicCrs ( ) const

Returns the geographic CRS associated with this CRS object.

May return an invalid CRS if the geographic CRS could not be determined.

Note: This method will always return a longitude, latitude ordered CRS.

Since: QGIS 3.24

Definition at line 3077 of file qgscoordinatereferencesystem.cpp.

◆ toOgcUri()

QString QgsCoordinateReferenceSystem::toOgcUri ( ) const

Returns the crs as OGC URI (format: http://www.opengis.net/def/crs/OGC/1.3/CRS84) Returns an empty string on failure.

Since: QGIS 3.30

Definition at line 1608 of file qgscoordinatereferencesystem.cpp.

◆ toOgcUrn()

QString QgsCoordinateReferenceSystem::toOgcUrn ( ) const

Returns the crs as OGC URN (format: urn:ogc:def:crs:OGC:1.3:CRS84) Returns an empty string on failure.

Since: QGIS 3.38

Definition at line 1631 of file qgscoordinatereferencesystem.cpp.

◆ toProj()

QString QgsCoordinateReferenceSystem::toProj ( ) const

Returns a Proj string representation of this CRS.

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.

Returns: Proj format string that defines this CRS.

Warning: Not all CRS definitions can be represented by Proj strings. An empty string will be returned if the CRS could not be represented by a Proj string.

See also: toWkt()

Since: QGIS 3.10.3

Definition at line 1327 of file qgscoordinatereferencesystem.cpp.

◆ toProj4()

QString QgsCoordinateReferenceSystem::toProj4 ( ) const

Returns a Proj string representation of this CRS.

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.

Returns: Proj format string that defines this CRS.

Warning: Not all CRS definitions can be represented by Proj strings. An empty string will be returned if the CRS could not be represented by a Proj string.

See also: toWkt()

Deprecated:: QGIS 3.10. Use toProj() instead.

Definition at line 1322 of file qgscoordinatereferencesystem.cpp.

◆ toWkt()

QString QgsCoordinateReferenceSystem::toWkt	(	Qgis::CrsWktVariant	variant = `Qgis::CrsWktVariant::Wkt1Gdal`,
		bool	multiline = `false`,
		int	indentationWidth = `4`
	)		const

Returns a WKT representation of this CRS.

The variant argument specifies the formatting variant to use when creating the WKT string. This is only used on builds based on Proj >= 6, with earlier versions always using WKT1_GDAL.

If multiline is true then a formatted multiline string will be returned, using the specified indentationWidth. This is only used on builds based on Proj >= 6.

See also: toProj()

Definition at line 2061 of file qgscoordinatereferencesystem.cpp.

◆ type()

Qgis::CrsType QgsCoordinateReferenceSystem::type ( ) const

Returns the type of the CRS.

Since: QGIS 3.34

Definition at line 1343 of file qgscoordinatereferencesystem.cpp.

◆ updateDefinition()

void QgsCoordinateReferenceSystem::updateDefinition ( )

Updates the definition and parameters of the coordinate reference system to their latest values.

This only has an effect if the CRS is a user defined custom CRS, and the definition of that custom CRS has changed. In this case the parameters of the object (such as the proj and WKT string definitions, and other related properties) will be updated to reflect the current definition of the custom CRS.

Any objects which store CRS objects should connect to the QgsApplication::coordinateReferenceSystemRegistry()'s QgsCoordinateReferenceSystemRegistry::userCrsChanged() signal and call this method on their stored CRS objects whenever the signal is emitted in order to update these CRSes to their new definitions.

Since: QGIS 3.18

Definition at line 1655 of file qgscoordinatereferencesystem.cpp.

◆ userFriendlyIdentifier()

QString QgsCoordinateReferenceSystem::userFriendlyIdentifier ( Qgis::CrsIdentifierType type = Qgis::CrsIdentifierType::MediumString ) const

Returns a user friendly identifier for the CRS.

Depending on the format of the CRS, this may reflect the CRSes registered name, or for CRSes not saved in the database it may reflect the underlying WKT or Proj string definition of the CRS.

In most cases this is the best method to use when showing a friendly identifier for the CRS to a user.

See also: description()

Since: QGIS 3.10.3

Definition at line 1246 of file qgscoordinatereferencesystem.cpp.

◆ validate()

void QgsCoordinateReferenceSystem::validate ( )

Perform some validation on this CRS.

If the CRS doesn't validate the default behavior 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 CRS to be valid.

See also: setCustomCrsValidation(); customCrsValidation()

Definition at line 533 of file qgscoordinatereferencesystem.cpp.

◆ validationHint()

QString QgsCoordinateReferenceSystem::validationHint ( ) const

Gets user hint for validation.

Definition at line 2405 of file qgscoordinatereferencesystem.cpp.

◆ validSrsIds()

QList< long > QgsCoordinateReferenceSystem::validSrsIds ( )

static

Returns a list of all valid SRS IDs present in the CRS database.

Any of the returned values can be safely passed to fromSrsId() to create a new, valid QgsCoordinateReferenceSystem object.

See also: fromSrsId()

Definition at line 142 of file qgscoordinatereferencesystem.cpp.

◆ verticalCrs()

QgsCoordinateReferenceSystem QgsCoordinateReferenceSystem::verticalCrs ( ) const

Returns the vertical CRS associated with this CRS object.

In the case of a compound CRS, this method will return just the vertical CRS component.

An invalid CRS will be returned if the object does not contain a vertical component.

See also: horizontalCrs(); hasVerticalAxis()

Since: QGIS 3.38

Definition at line 3139 of file qgscoordinatereferencesystem.cpp.

◆ writeXml()

bool QgsCoordinateReferenceSystem::writeXml	(	QDomNode &	node,
		QDomDocument &	doc
	)		const

Stores state to the given Dom node in the given document.

Parameters

node	The node in which state will be restored
doc	The document in which state will be stored

Returns: bool true on success, false on failure

Definition at line 2231 of file qgscoordinatereferencesystem.cpp.

Friends And Related Symbol Documentation

◆ operator<

bool CORE_EXPORT operator<	(	const QgsCoordinateReferenceSystem &	c1,
		const QgsCoordinateReferenceSystem &	c2
	)

friend

Definition at line 3409 of file qgscoordinatereferencesystem.cpp.

◆ operator<=

bool CORE_EXPORT operator<=	(	const QgsCoordinateReferenceSystem &	c1,
		const QgsCoordinateReferenceSystem &	c2
	)

friend

Definition at line 3462 of file qgscoordinatereferencesystem.cpp.

◆ operator>

bool CORE_EXPORT operator>	(	const QgsCoordinateReferenceSystem &	c1,
		const QgsCoordinateReferenceSystem &	c2
	)

friend

Definition at line 3360 of file qgscoordinatereferencesystem.cpp.

◆ operator>=

bool CORE_EXPORT operator>=	(	const QgsCoordinateReferenceSystem &	c1,
		const QgsCoordinateReferenceSystem &	c2
	)

friend

Definition at line 3458 of file qgscoordinatereferencesystem.cpp.

◆ QgsCoordinateReferenceSystemRegistry

friend class QgsCoordinateReferenceSystemRegistry

friend

Definition at line 1297 of file qgscoordinatereferencesystem.h.

◆ QgsProjContext

friend class QgsProjContext

friend

Definition at line 1271 of file qgscoordinatereferencesystem.h.

◆ TestQgsCoordinateReferenceSystem

friend class TestQgsCoordinateReferenceSystem

friend

Definition at line 1296 of file qgscoordinatereferencesystem.h.

Property Documentation

◆ authid

QString QgsCoordinateReferenceSystem::authid

read

Definition at line 217 of file qgscoordinatereferencesystem.h.

◆ description

QString QgsCoordinateReferenceSystem::description

read

Definition at line 218 of file qgscoordinatereferencesystem.h.

◆ isGeographic

bool QgsCoordinateReferenceSystem::isGeographic

read

Definition at line 216 of file qgscoordinatereferencesystem.h.

◆ mapUnits

Qgis::DistanceUnit QgsCoordinateReferenceSystem::mapUnits

read

Definition at line 215 of file qgscoordinatereferencesystem.h.

The documentation for this class was generated from the following files:

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/proj/qgscoordinatereferencesystem.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/proj/qgscoordinatereferencesystem.cpp

Public Types

Public Member Functions

Static Public Member Functions

Properties

Friends

Detailed Description

CRS Definition Formats

CRS Database and Custom CRS

Validation

Object Construction and Copying

Caveats

Member Enumeration Documentation

◆ CrsType

Constructor & Destructor Documentation

◆ QgsCoordinateReferenceSystem() [1/4]

◆ ~QgsCoordinateReferenceSystem()

◆ QgsCoordinateReferenceSystem() [2/4]

◆ QgsCoordinateReferenceSystem() [3/4]

◆ QgsCoordinateReferenceSystem() [4/4]

Member Function Documentation

◆ authid()

◆ axisOrdering()

◆ bounds()

◆ celestialBodyName()

◆ clearRecentCoordinateReferenceSystems()

◆ coordinateEpoch()

◆ createCompoundCrs()

◆ createFromId()

◆ createFromOgcWmsCrs()

◆ createFromProj()

◆ createFromProj4()

◆ createFromProjObject()

◆ createFromSrid()

◆ createFromSrsId()

◆ createFromString()

◆ createFromUserInput()

◆ createFromWkt()

◆ customCrsValidation()

◆ datumEnsemble()

◆ description()

◆ ellipsoidAcronym()

◆ factors()

◆ findMatchingProj()

◆ fromEpsgId()

◆ fromOgcWmsCrs()

◆ fromProj()

◆ fromProj4()

◆ fromProjObject()

◆ fromSrsId()

◆ fromWkt()

◆ geographicCrsAuthId()

◆ hasAxisInverted()

◆ hasVerticalAxis()

◆ horizontalCrs()

◆ invalidateCache()

◆ isDeprecated()

◆ isDynamic()

◆ isGeographic()

◆ isValid()

◆ mapUnits()

◆ nativeFormat()

◆ operation()

◆ operator QVariant()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ postgisSrid()

◆ projectionAcronym()

◆ projObject()

◆ pushRecentCoordinateReferenceSystem()

◆ readXml()

◆ recentCoordinateReferenceSystems()

◆ recentProjections()

◆ removeRecentCoordinateReferenceSystem()

◆ saveAsUserCrs()

◆ setCoordinateEpoch()

◆ setCustomCrsValidation()

◆ setNativeFormat()

◆ setupESRIWktFix()

◆ setValidationHint()