Class: QgsGml

Reads data from a WFS server or alternatively from a GML file.

It uses the expat XML parser and an event based model to keep performance high. The parsing starts when the first data arrives, it does not wait until the request is finished.

Class Hierarchy

Base classes

QObject

Methods

crs	Returns the spatial reference system for features.
featuresMap	Gets parsed features for given type name
getFeatures	Read from GML data.
getFeaturesUri	Does the HTTP GET request to the WFS server
idsMap	Gets feature ids map

Signals

dataProgressAndSteps	Emitted when data reading progresses or the total number of bytes to read changes.
dataReadProgress	Emitted when data reading progresses.
totalStepsUpdate	Emitted when the total number of bytes to read changes.

class qgis.core.QgsGml

Bases: QObject

crs(self) → QgsCoordinateReferenceSystem

Returns the spatial reference system for features.

Return type:

QgsCoordinateReferenceSystem

signal dataProgressAndSteps(progress: int, totalSteps: int)

Emitted when data reading progresses or the total number of bytes to read changes.

Parameters:

• progress (int) – specifies the number of bytes processed so far

• totalSteps (int) – specifies the total number of bytes which must be processed

signal dataReadProgress(progress: int)

Emitted when data reading progresses.

Parameters:

progress (int) – specifies the number of bytes processed so far

featuresMap(self) → Any

Gets parsed features for given type name

Return type:

Any

getFeatures(self, data: QByteArray | bytes | bytearray, extent: QgsRectangle | None = None)

Read from GML data.

The constructor uri param is ignored.

Parameters:

• data (Union[QByteArray, bytes, bytearray])

• extent (Optional[QgsRectangle] = None) -> (int)

getFeaturesUri(self, uri: str | None, extent: QgsRectangle | None = None, userName: str | None = '', password: str | None = '', authcfg: str | None = '')

Does the HTTP GET request to the WFS server

Parameters:

• uri (Optional[str]) – GML URL

• wkbType – wkbType to retrieve

• extent (Optional[QgsRectangle] = None) – retrieved extents

• userName (Optional[str] = '') – username for authentication

• password (Optional[str] = '') – password for authentication

• authcfg (Optional[str] = '') -> (int) – authentication configuration id

Returns:

0 in case of success

idsMap(self) → Any

Gets feature ids map

Return type:

Any

signal totalStepsUpdate(totalSteps: int)

Emitted when the total number of bytes to read changes.

Parameters:

totalSteps (int) – specifies the total number of bytes which must be processed