The QgsOgcUtils class provides various utility functions for conversion between OGC (Open Geospatial Consortium) standards and QGIS internal representations. More...

#include <qgsogcutils.h>

Classes
struct	Context
	The Context struct stores the current layer and coordinate transform context. More...

class	LayerProperties
	Layer properties. More...

Public Types
enum	FilterVersion { FILTER_OGC_1_0 , FILTER_OGC_1_1 , FILTER_FES_2_0 }
	OGC filter version. More...

enum	GMLVersion { GML_2_1_2 , GML_3_1_0 , GML_3_2_1 }
	GML version. More...

Static Public Member Functions
static QColor	colorFromOgcFill (const QDomElement &fillElement)
	Parse XML with OGC fill into QColor. More...

static QgsExpression *	expressionFromOgcFilter (const QDomElement &element, FilterVersion version, QgsVectorLayer *layer=nullptr)
	Returns an expression from a WFS filter embedded in a document. More...

static QgsExpression *	expressionFromOgcFilter (const QDomElement &element, QgsVectorLayer *layer=nullptr)
	Parse XML with OGC filter into QGIS expression. More...

static QDomElement	expressionToOgcExpression (const QgsExpression &exp, QDomDocument &doc, QgsOgcUtils::GMLVersion gmlVersion, FilterVersion filterVersion, const QString &geometryName, const QString &srsName, bool honourAxisOrientation, bool invertAxisOrientation, QString *errorMessage=nullptr)
	Creates an OGC expression XML element. More...

static QDomElement	expressionToOgcExpression (const QgsExpression &exp, QDomDocument &doc, QString *errorMessage=nullptr)
	Creates an OGC expression XML element. More...

static QDomElement	expressionToOgcFilter (const QgsExpression &exp, QDomDocument &doc, QgsOgcUtils::GMLVersion gmlVersion, FilterVersion filterVersion, const QString &geometryName, const QString &srsName, bool honourAxisOrientation, bool invertAxisOrientation, QString *errorMessage=nullptr)
	Creates OGC filter XML element. More...

static QDomElement	expressionToOgcFilter (const QgsExpression &exp, QDomDocument &doc, QString *errorMessage=nullptr)
	Creates OGC filter XML element. More...

static QgsGeometry	geometryFromGML (const QDomNode &geometryNode, const QgsOgcUtils::Context &context=QgsOgcUtils::Context())
	Static method that creates geometry from GML. More...

static QgsGeometry	geometryFromGML (const QString &xmlString, const QgsOgcUtils::Context &context=QgsOgcUtils::Context())
	Static method that creates geometry from GML. More...

static QDomElement	geometryToGML (const QgsGeometry &geometry, QDomDocument &doc, const QString &format, int precision=17)
	Exports the geometry to GML2 or GML3. More...

static QDomElement	geometryToGML (const QgsGeometry &geometry, QDomDocument &doc, int precision=17)
	Exports the geometry to GML2. More...

static QDomElement	geometryToGML (const QgsGeometry &geometry, QDomDocument &doc, QgsOgcUtils::GMLVersion gmlVersion, const QString &srsName, bool invertAxisOrientation, const QString &gmlIdBase, int precision=17)
	Exports the geometry to GML. More...

static QgsRectangle	rectangleFromGMLBox (const QDomNode &boxNode)
	Read rectangle from GML2 Box. More...

static QgsRectangle	rectangleFromGMLEnvelope (const QDomNode &envelopeNode)
	Read rectangle from GML3 Envelope. More...

static QDomElement	rectangleToGMLBox (QgsRectangle *box, QDomDocument &doc, const QString &srsName, bool invertAxisOrientation, int precision=17)
	Exports the rectangle to GML2 Box. More...

static QDomElement	rectangleToGMLBox (QgsRectangle *box, QDomDocument &doc, int precision=17)
	Exports the rectangle to GML2 Box. More...

static QDomElement	rectangleToGMLEnvelope (QgsRectangle *env, QDomDocument &doc, const QString &srsName, bool invertAxisOrientation, int precision=17)
	Exports the rectangle to GML3 Envelope. More...

static QDomElement	rectangleToGMLEnvelope (QgsRectangle *env, QDomDocument &doc, int precision=17)
	Exports the rectangle to GML3 Envelope. More...

static QDomElement	SQLStatementToOgcFilter (const QgsSQLStatement &statement, QDomDocument &doc, QgsOgcUtils::GMLVersion gmlVersion, FilterVersion filterVersion, const QList< LayerProperties > &layerProperties, bool honourAxisOrientation, bool invertAxisOrientation, const QMap< QString, QString > &mapUnprefixedTypenameToPrefixedTypename, QString *errorMessage=nullptr)
	Creates OGC filter XML element from the WHERE and JOIN clauses of a SQL statement. More...

Detailed Description

The QgsOgcUtils class provides various utility functions for conversion between OGC (Open Geospatial Consortium) standards and QGIS internal representations.

Currently supported standards:

GML2 - Geography Markup Language (import, export)

Definition at line 50 of file qgsogcutils.h.

Member Enumeration Documentation

◆ FilterVersion

enum QgsOgcUtils::FilterVersion

OGC filter version.

Enumerator
FILTER_OGC_1_0
FILTER_OGC_1_1
FILTER_FES_2_0

Definition at line 177 of file qgsogcutils.h.

◆ GMLVersion

enum QgsOgcUtils::GMLVersion

GML version.

Enumerator
GML_2_1_2
GML_3_1_0
GML_3_2_1

Definition at line 76 of file qgsogcutils.h.

Member Function Documentation

◆ colorFromOgcFill()

QColor QgsOgcUtils::colorFromOgcFill ( const QDomElement & fillElement )

static

Parse XML with OGC fill into QColor.

Definition at line 1630 of file qgsogcutils.cpp.

◆ expressionFromOgcFilter() [1/2]

QgsExpression * QgsOgcUtils::expressionFromOgcFilter	(	const QDomElement &	element,
		FilterVersion	version,
		QgsVectorLayer *	layer = `nullptr`
	)

static

Returns an expression from a WFS filter embedded in a document.

Parameters

element	The WFS Filter
version	The WFS version
layer	Layer to use to retrieve field values from literal filters

Since: QGIS 3.4

Definition at line 1674 of file qgsogcutils.cpp.

◆ expressionFromOgcFilter() [2/2]

QgsExpression * QgsOgcUtils::expressionFromOgcFilter	(	const QDomElement &	element,
		QgsVectorLayer *	layer = `nullptr`
	)

static

Parse XML with OGC filter into QGIS expression.

Definition at line 1669 of file qgsogcutils.cpp.

◆ expressionToOgcExpression() [1/2]

QDomElement QgsOgcUtils::expressionToOgcExpression	(	const QgsExpression &	exp,
		QDomDocument &	doc,
		QgsOgcUtils::GMLVersion	gmlVersion,
		FilterVersion	filterVersion,
		const QString &	geometryName,
		const QString &	srsName,
		bool	honourAxisOrientation,
		bool	invertAxisOrientation,
		QString *	errorMessage = `nullptr`
	)

static

Creates an OGC expression XML element.

Returns: valid OGC expression QDomElement on success, otherwise null QDomElement

Definition at line 1907 of file qgsogcutils.cpp.

◆ expressionToOgcExpression() [2/2]

QDomElement QgsOgcUtils::expressionToOgcExpression	(	const QgsExpression &	exp,
		QDomDocument &	doc,
		QString *	errorMessage = `nullptr`
	)

static

Creates an OGC expression XML element.

Returns: valid OGC expression QDomElement on success, otherwise null QDomElement

Definition at line 1860 of file qgsogcutils.cpp.

◆ expressionToOgcFilter() [1/2]

QDomElement QgsOgcUtils::expressionToOgcFilter	(	const QgsExpression &	exp,
		QDomDocument &	doc,
		QgsOgcUtils::GMLVersion	gmlVersion,
		FilterVersion	filterVersion,
		const QString &	geometryName,
		const QString &	srsName,
		bool	honourAxisOrientation,
		bool	invertAxisOrientation,
		QString *	errorMessage = `nullptr`
	)

static

Creates OGC filter XML element.

Supports minimum standard filter according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT)

Returns

valid

<Filter>

QDomElement on success, otherwise null QDomElement

Note: not available in Python bindings

Since: QGIS 2.16

Definition at line 1866 of file qgsogcutils.cpp.

◆ expressionToOgcFilter() [2/2]

QDomElement QgsOgcUtils::expressionToOgcFilter	(	const QgsExpression &	exp,
		QDomDocument &	doc,
		QString *	errorMessage = `nullptr`
	)

static

Creates OGC filter XML element.

Supports minimum standard filter according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT)

Returns

valid

<Filter>

QDomElement on success, otherwise null QDomElement

Definition at line 1854 of file qgsogcutils.cpp.

◆ geometryFromGML() [1/2]

QgsGeometry QgsOgcUtils::geometryFromGML	(	const QDomNode &	geometryNode,
		const QgsOgcUtils::Context &	context = `QgsOgcUtils::Context()`
	)

static

Static method that creates geometry from GML.

Definition at line 77 of file qgsogcutils.cpp.

◆ geometryFromGML() [2/2]

QgsGeometry QgsOgcUtils::geometryFromGML	(	const QString &	xmlString,
		const QgsOgcUtils::Context &	context = `QgsOgcUtils::Context()`
	)

static

Static method that creates geometry from GML.

Parameters

xmlString

xml representation of the geometry. GML elements are expected to be in default namespace (

{<Point>...</Point>

) or in "gml" namespace (

<gml:Point>...</gml:Point>

)

context QgsOgcUtils context

Definition at line 187 of file qgsogcutils.cpp.

◆ geometryToGML() [1/3]

QDomElement QgsOgcUtils::geometryToGML	(	const QgsGeometry &	geometry,
		QDomDocument &	doc,
		const QString &	format,
		int	precision = `17`
	)

static

Exports the geometry to GML2 or GML3.

Returns: QDomElement

Definition at line 1191 of file qgsogcutils.cpp.

◆ geometryToGML() [2/3]

QDomElement QgsOgcUtils::geometryToGML	(	const QgsGeometry &	geometry,
		QDomDocument &	doc,
		int	precision = `17`
	)

static

Exports the geometry to GML2.

Returns: QDomElement

Definition at line 1572 of file qgsogcutils.cpp.

◆ geometryToGML() [3/3]

QDomElement QgsOgcUtils::geometryToGML	(	const QgsGeometry &	geometry,
		QDomDocument &	doc,
		QgsOgcUtils::GMLVersion	gmlVersion,
		const QString &	srsName,
		bool	invertAxisOrientation,
		const QString &	gmlIdBase,
		int	precision = `17`
	)

static

Exports the geometry to GML.

Returns: QDomElement

Since: QGIS 2.16

Definition at line 1196 of file qgsogcutils.cpp.

◆ rectangleFromGMLBox()

QgsRectangle QgsOgcUtils::rectangleFromGMLBox ( const QDomNode & boxNode )

static

Read rectangle from GML2 Box.

Definition at line 946 of file qgsogcutils.cpp.

◆ rectangleFromGMLEnvelope()

QgsRectangle QgsOgcUtils::rectangleFromGMLEnvelope ( const QDomNode & envelopeNode )

static

Read rectangle from GML3 Envelope.

Definition at line 1031 of file qgsogcutils.cpp.

◆ rectangleToGMLBox() [1/2]

QDomElement QgsOgcUtils::rectangleToGMLBox	(	QgsRectangle *	box,
		QDomDocument &	doc,
		const QString &	srsName,
		bool	invertAxisOrientation,
		int	precision = `17`
	)

static

Exports the rectangle to GML2 Box.

Returns: QDomElement

Since: QGIS 2.16

Definition at line 1115 of file qgsogcutils.cpp.

◆ rectangleToGMLBox() [2/2]

QDomElement QgsOgcUtils::rectangleToGMLBox	(	QgsRectangle *	box,
		QDomDocument &	doc,
		int	precision = `17`
	)

static

Exports the rectangle to GML2 Box.

Returns: QDomElement

Definition at line 1110 of file qgsogcutils.cpp.

◆ rectangleToGMLEnvelope() [1/2]

QDomElement QgsOgcUtils::rectangleToGMLEnvelope	(	QgsRectangle *	env,
		QDomDocument &	doc,
		const QString &	srsName,
		bool	invertAxisOrientation,
		int	precision = `17`
	)

static

Exports the rectangle to GML3 Envelope.

Returns: QDomElement

Since: QGIS 2.16

Definition at line 1155 of file qgsogcutils.cpp.

◆ rectangleToGMLEnvelope() [2/2]

QDomElement QgsOgcUtils::rectangleToGMLEnvelope	(	QgsRectangle *	env,
		QDomDocument &	doc,
		int	precision = `17`
	)

static

Exports the rectangle to GML3 Envelope.

Returns: QDomElement

Definition at line 1150 of file qgsogcutils.cpp.

◆ SQLStatementToOgcFilter()

QDomElement QgsOgcUtils::SQLStatementToOgcFilter	(	const QgsSQLStatement &	statement,
		QDomDocument &	doc,
		QgsOgcUtils::GMLVersion	gmlVersion,
		FilterVersion	filterVersion,
		const QList< LayerProperties > &	layerProperties,
		bool	honourAxisOrientation,
		bool	invertAxisOrientation,
		const QMap< QString, QString > &	mapUnprefixedTypenameToPrefixedTypename,
		QString *	errorMessage = `nullptr`
	)

static

Creates OGC filter XML element from the WHERE and JOIN clauses of a SQL statement.

Supports minimum standard filter according to the OGC filter specs (=,!=,<,>,<=,>=,AND,OR,NOT,LIKE,BETWEEN,IN) Supports layer joins. Supports ST_GeometryFromText(wkt[, srid/srsname]), ST_MakeEnvelope(xmin,ymin,xmax,ymax[, srid/srsname]) ST_GeomFromGML(serialized_gml_string) BBOX() ST_Intersects(), ST_Contains(), ST_Crosses(), ST_Equals(), ST_Disjoint(), ST_Overlaps(), ST_Touches(), ST_Within() ST_DWithin(), ST_Beyond() custom functions

Returns

valid

<Filter>

QDomElement on success, otherwise null QDomElement

Note: not available in Python bindings

Since: QGIS 2.16

Definition at line 1954 of file qgsogcutils.cpp.

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

/build/qgis-3.18.1+99unstable/src/core/qgsogcutils.h
/build/qgis-3.18.1+99unstable/src/core/qgsogcutils.cpp

Classes

Public Types

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ FilterVersion

◆ GMLVersion

Member Function Documentation

◆ colorFromOgcFill()

◆ expressionFromOgcFilter() [1/2]

◆ expressionFromOgcFilter() [2/2]

◆ expressionToOgcExpression() [1/2]

◆ expressionToOgcExpression() [2/2]

◆ expressionToOgcFilter() [1/2]

◆ expressionToOgcFilter() [2/2]

◆ geometryFromGML() [1/2]

◆ geometryFromGML() [2/2]

◆ geometryToGML() [1/3]

◆ geometryToGML() [2/3]

◆ geometryToGML() [3/3]

◆ rectangleFromGMLBox()

◆ rectangleFromGMLEnvelope()

◆ rectangleToGMLBox() [1/2]

◆ rectangleToGMLBox() [2/2]

◆ rectangleToGMLEnvelope() [1/2]

◆ rectangleToGMLEnvelope() [2/2]

◆ SQLStatementToOgcFilter()