QGIS/python/core/auto_generated/qgsgml.sip.in
2024-09-04 13:54:39 +10:00

112 lines
3.3 KiB
Plaintext

/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsgml.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/
class QgsGml : QObject
{
%Docstring(signature="appended")
This class 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.
%End
%TypeHeaderCode
#include "qgsgml.h"
%End
public:
QgsGml(
const QString &typeName,
const QString &geometryAttribute,
const QgsFields &fields );
int getFeatures( const QString &uri,
Qgis::WkbType *wkbType,
QgsRectangle *extent = 0,
const QString &userName = QString(),
const QString &password = QString(),
const QString &authcfg = QString() ) /PyName=getFeaturesUri/;
%Docstring
Does the HTTP GET request to the WFS server
:param uri: GML URL
:param wkbType: wkbType to retrieve
:param extent: retrieved extents
:param userName: username for authentication
:param password: password for authentication
:param authcfg: authentication configuration id
:return: 0 in case of success
.. note::
available in Python as getFeaturesUri
%End
int getFeatures( const QByteArray &data, Qgis::WkbType *wkbType, QgsRectangle *extent = 0 );
%Docstring
Read from GML data.
The constructor uri param is ignored.
%End
QMap<QgsFeatureId, QgsFeature * > featuresMap() const;
%Docstring
Gets parsed features for given type name
%End
QMap<QgsFeatureId, QString > idsMap() const;
%Docstring
Gets feature ids map
%End
QgsCoordinateReferenceSystem crs() const;
%Docstring
Returns the spatial reference system for features.
%End
signals:
void dataReadProgress( int progress );
%Docstring
Emitted when data reading progresses.
:param progress: specifies the number of bytes processed so far
%End
void totalStepsUpdate( int totalSteps );
%Docstring
Emitted when the total number of bytes to read changes.
:param totalSteps: specifies the total number of bytes which must be processed
%End
void dataProgressAndSteps( int progress, int totalSteps );
%Docstring
Emitted when data reading progresses or the total number of bytes to read changes.
:param progress: specifies the number of bytes processed so far
:param totalSteps: specifies the total number of bytes which must be processed
%End
};
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsgml.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.py again *
************************************************************************/