QgsGmlStreamingParser Class Reference

This class builds features from GML data in a streaming way. More...

#include <qgsgml.h>

Classes
class	LayerProperties
	Layer properties. More...

Public Types
enum	AxisOrientationLogic { Honour_EPSG_if_urn , Honour_EPSG , Ignore_EPSG }
	Axis orientation logic. More...
typedef QPair< QgsFeature *, QString >	QgsGmlFeaturePtrGmlIdPair

Public Member Functions
	QgsGmlStreamingParser (const QgsGmlStreamingParser &other)=delete
	QgsGmlStreamingParser (const QList< LayerProperties > &layerProperties, const QgsFields &fields, const QMap< QString, QPair< QString, QString > > &fieldNameToSrcLayerNameFieldNameMap, AxisOrientationLogic axisOrientationLogic=Honour_EPSG_if_urn, bool invertAxisOrientation=false)
	Constructor for a join layer, or dealing with renamed fields.
	QgsGmlStreamingParser (const QString &typeName, const QString &geometryAttribute, const QgsFields &fields, AxisOrientationLogic axisOrientationLogic=Honour_EPSG_if_urn, bool invertAxisOrientation=false)
	Constructor.
	~QgsGmlStreamingParser ()
QString	exceptionText () const
	Returns the exception text.
QVector< QgsGmlFeaturePtrGmlIdPair >	getAndStealReadyFeatures ()
	Returns the list of features that have been completely parsed.
int	getEPSGCode () const
	Returns the EPSG code, or 0 if unknown.
bool	isException () const
	Returns whether the document parser is a OGC exception.
bool	isTruncatedResponse () const
	Returns whether a "truncatedResponse" element is found.
const QgsRectangle &	layerExtent () const
	Returns layer bounding box.
int	numberMatched () const
	Returns WFS 2.0 "numberMatched" attribute, or -1 if invalid/not found.
int	numberReturned () const
	Returns WFS 2.0 "numberReturned" or WFS 1.1 "numberOfFeatures" attribute, or -1 if invalid/not found.
QgsGmlStreamingParser &	operator= (const QgsGmlStreamingParser &other)=delete
bool	processData (const QByteArray &data, bool atEnd)
	Process a new chunk of data.
bool	processData (const QByteArray &data, bool atEnd, QString &errorMsg)
	Process a new chunk of data.
void	setFieldsXPath (const QMap< QString, QPair< QString, bool > > &fieldNameToSrcLayerNameFieldNameMap, const QMap< QString, QString > &namespacePrefixToURIMap)
	Define the XPath of the attributes and whether they are made of nested content.
QString	srsName () const
	Returns the value of the srsName attribute.
Qgis::WkbType	wkbType () const
	Returns the geometry type.

Detailed Description

This class builds features from GML data in a streaming way.

The caller must call processData() as soon it has new content from the source. At any point, it can call getAndStealReadyFeatures() to collect the features that have been completely parsed.

Note

not available in Python bindings

Definition at line 54 of file qgsgml.h.

Member Typedef Documentation

QgsGmlFeaturePtrGmlIdPair

typedef QPair<QgsFeature *, QString> QgsGmlStreamingParser::QgsGmlFeaturePtrGmlIdPair

Definition at line 58 of file qgsgml.h.

Member Enumeration Documentation

AxisOrientationLogic

enum QgsGmlStreamingParser::AxisOrientationLogic

Axis orientation logic.

Enumerator
Honour_EPSG_if_urn	Honour EPSG axis order only if srsName is of the form urn:ogc:def:crs:EPSG:
Honour_EPSG	Honour EPSG axis order.
Ignore_EPSG	Ignore EPSG axis order.

Definition at line 77 of file qgsgml.h.

Constructor & Destructor Documentation

QgsGmlStreamingParser() [1/3]

QgsGmlStreamingParser::QgsGmlStreamingParser	(	const QString &	typeName,
		const QString &	geometryAttribute,
		const QgsFields &	fields,
		AxisOrientationLogic	axisOrientationLogic = Honour_EPSG_if_urn,
		bool	invertAxisOrientation = false
	)

Constructor.

Definition at line 282 of file qgsgml.cpp.

QgsGmlStreamingParser() [2/3]

QgsGmlStreamingParser::QgsGmlStreamingParser	(	const QList< LayerProperties > &	layerProperties,
		const QgsFields &	fields,
		const QMap< QString, QPair< QString, QString > > &	fieldNameToSrcLayerNameFieldNameMap,
		AxisOrientationLogic	axisOrientationLogic = Honour_EPSG_if_urn,
		bool	invertAxisOrientation = false
	)

Constructor for a join layer, or dealing with renamed fields.

Definition at line 344 of file qgsgml.cpp.

~QgsGmlStreamingParser()

QgsGmlStreamingParser::~QgsGmlStreamingParser

(

)

Definition at line 436 of file qgsgml.cpp.

QgsGmlStreamingParser() [3/3]

QgsGmlStreamingParser::QgsGmlStreamingParser ( const QgsGmlStreamingParser &  other )

delete

Member Function Documentation

exceptionText()

QString QgsGmlStreamingParser::exceptionText ( ) const

inline

Returns the exception text.

Definition at line 156 of file qgsgml.h.

getAndStealReadyFeatures()

QVector< QgsGmlStreamingParser::QgsGmlFeaturePtrGmlIdPair > QgsGmlStreamingParser::getAndStealReadyFeatures

(

)

Returns the list of features that have been completely parsed.

This can be called at any point. This will empty the list maintained internally by the parser, so that features already returned will no longer be returned by later calls.

Definition at line 506 of file qgsgml.cpp.

getEPSGCode()

int QgsGmlStreamingParser::getEPSGCode ( ) const

inline

Returns the EPSG code, or 0 if unknown.

Definition at line 135 of file qgsgml.h.

isException()

bool QgsGmlStreamingParser::isException ( ) const

inline

Returns whether the document parser is a OGC exception.

Definition at line 153 of file qgsgml.h.

isTruncatedResponse()

bool QgsGmlStreamingParser::isTruncatedResponse ( ) const

inline

Returns whether a "truncatedResponse" element is found.

Definition at line 159 of file qgsgml.h.

layerExtent()

const QgsRectangle & QgsGmlStreamingParser::layerExtent ( ) const

inline

Returns layer bounding box.

Definition at line 141 of file qgsgml.h.

numberMatched()

int QgsGmlStreamingParser::numberMatched ( ) const

inline

Returns WFS 2.0 "numberMatched" attribute, or -1 if invalid/not found.

Definition at line 147 of file qgsgml.h.

numberReturned()

int QgsGmlStreamingParser::numberReturned ( ) const

inline

Returns WFS 2.0 "numberReturned" or WFS 1.1 "numberOfFeatures" attribute, or -1 if invalid/not found.

Definition at line 150 of file qgsgml.h.

operator=()

QgsGmlStreamingParser & QgsGmlStreamingParser::operator= ( const QgsGmlStreamingParser &  other )

delete

processData() [1/2]

bool QgsGmlStreamingParser::processData	(	const QByteArray &	data,
		bool	atEnd
	)

Process a new chunk of data.

atEnd must be set to true when this is the last chunk of data.

Definition at line 450 of file qgsgml.cpp.

processData() [2/2]

bool QgsGmlStreamingParser::processData	(	const QByteArray &	data,
		bool	atEnd,
		QString &	errorMsg
	)

Process a new chunk of data.

atEnd must be set to true when this is the last chunk of data.

Definition at line 461 of file qgsgml.cpp.

setFieldsXPath()

void QgsGmlStreamingParser::setFieldsXPath	(	const QMap< QString, QPair< QString, bool > > &	fieldNameToSrcLayerNameFieldNameMap,
		const QMap< QString, QString > &	namespacePrefixToURIMap
	)

Define the XPath of the attributes and whether they are made of nested content.

Also provides a map from namespace prefix to namespace URI, to help decoding the XPath.

Definition at line 423 of file qgsgml.cpp.

srsName()

QString QgsGmlStreamingParser::srsName ( ) const

inline

Returns the value of the srsName attribute.

Definition at line 138 of file qgsgml.h.

wkbType()

Qgis::WkbType QgsGmlStreamingParser::wkbType ( ) const

inline

Returns the geometry type.

Definition at line 144 of file qgsgml.h.

---

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

• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/qgsgml.h
• /build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/qgsgml.cpp