QGIS API Documentation  2.18.3-Las Palmas (77b8c3d)
Static Public Member Functions | List of all members
QgsOgrUtils Class Reference

Utilities for working with OGR features and layers. More...

#include <qgsogrutils.h>

Static Public Member Functions

static QVariant getOgrFeatureAttribute (OGRFeatureH ogrFet, const QgsFields &fields, int attIndex, QTextCodec *encoding, bool *ok=0)
 Retrieves an attribute value from an OGR feature. More...
 
static QgsGeometryogrGeometryToQgsGeometry (OGRGeometryH geom)
 Converts an OGR geometry representation to a QgsGeometry object. More...
 
static QgsFeature readOgrFeature (OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding)
 Reads an OGR feature and converts it to a QgsFeature. More...
 
static bool readOgrFeatureAttributes (OGRFeatureH ogrFet, const QgsFields &fields, QgsFeature &feature, QTextCodec *encoding)
 Reads all attributes from an OGR feature into a QgsFeature. More...
 
static bool readOgrFeatureGeometry (OGRFeatureH ogrFet, QgsFeature &feature)
 Reads the geometry from an OGR feature into a QgsFeature. More...
 
static QgsFields readOgrFields (OGRFeatureH ogrFet, QTextCodec *encoding)
 Reads an OGR feature and returns a corresponding fields collection. More...
 
static QgsFeatureList stringToFeatureList (const QString &string, const QgsFields &fields, QTextCodec *encoding)
 Attempts to parse a string representing a collection of features using OGR. More...
 
static QgsFields stringToFields (const QString &string, QTextCodec *encoding)
 Attempts to retrieve the fields from a string representing a collection of features using OGR. More...
 

Detailed Description

Utilities for working with OGR features and layers.

Contains helper utilities for assisting work with both OGR features and layers.

Note
Added in version 2.16
not available in Python bindings

Definition at line 33 of file qgsogrutils.h.

Member Function Documentation

QVariant QgsOgrUtils::getOgrFeatureAttribute ( OGRFeatureH  ogrFet,
const QgsFields fields,
int  attIndex,
QTextCodec encoding,
bool *  ok = 0 
)
static

Retrieves an attribute value from an OGR feature.

Parameters
ogrFetOGR feature handle
fieldsfields collection corresponding to feature
attIndexindex of attribute to retrieve
encodingtext encoding
okoptional storage for success of retrieval
Returns
attribute converted to a QVariant object
See also
readOgrFeatureAttributes()

Definition at line 110 of file qgsogrutils.cpp.

QgsGeometry * QgsOgrUtils::ogrGeometryToQgsGeometry ( OGRGeometryH  geom)
static

Converts an OGR geometry representation to a QgsGeometry object.

Parameters
geomOGR geometry handle
Returns
new QgsGeometry object, if conversion was successful
See also
readOgrFeatureGeometry()

Definition at line 222 of file qgsogrutils.cpp.

QgsFeature QgsOgrUtils::readOgrFeature ( OGRFeatureH  ogrFet,
const QgsFields fields,
QTextCodec encoding 
)
static

Reads an OGR feature and converts it to a QgsFeature.

Parameters
ogrFetOGR feature handle
fieldsfields collection corresponding to feature
encodingtext encoding
Returns
valid feature if read was successful

Definition at line 33 of file qgsogrutils.cpp.

bool QgsOgrUtils::readOgrFeatureAttributes ( OGRFeatureH  ogrFet,
const QgsFields fields,
QgsFeature feature,
QTextCodec encoding 
)
static

Reads all attributes from an OGR feature into a QgsFeature.

Parameters
ogrFetOGR feature handle
fieldsfields collection corresponding to feature
featureQgsFeature to store attributes in
encodingtext encoding
Returns
true if attribute read was successful
See also
getOgrFeatureAttribute()

Definition at line 187 of file qgsogrutils.cpp.

bool QgsOgrUtils::readOgrFeatureGeometry ( OGRFeatureH  ogrFet,
QgsFeature feature 
)
static

Reads the geometry from an OGR feature into a QgsFeature.

Parameters
ogrFetOGR feature handle
featureQgsFeature to store geometry in
Returns
true if geometry read was successful
See also
readOgrFeatureAttributes()
ogrGeometryToQgsGeometry()

Definition at line 208 of file qgsogrutils.cpp.

QgsFields QgsOgrUtils::readOgrFields ( OGRFeatureH  ogrFet,
QTextCodec encoding 
)
static

Reads an OGR feature and returns a corresponding fields collection.

Parameters
ogrFetOGR feature handle
encodingtext encoding
Returns
fields collection if read was successful

Definition at line 58 of file qgsogrutils.cpp.

QgsFeatureList QgsOgrUtils::stringToFeatureList ( const QString string,
const QgsFields fields,
QTextCodec encoding 
)
static

Attempts to parse a string representing a collection of features using OGR.

For example, this method can be used to convert a GeoJSON encoded collection to a list of QgsFeatures.

Parameters
stringstring to parse
fieldsfields collection to use for parsed features (
See also
stringToFields())
Parameters
encodingtext encoding
Returns
list of parsed features, or an empty list if no features could be parsed
See also
stringToFields()

Definition at line 237 of file qgsogrutils.cpp.

QgsFields QgsOgrUtils::stringToFields ( const QString string,
QTextCodec encoding 
)
static

Attempts to retrieve the fields from a string representing a collection of features using OGR.

Parameters
stringstring to parse
encodingtext encoding
Returns
retrieved fields collection, or an empty list if no fields could be determined from the string
See also
stringToFeatureList()

Definition at line 281 of file qgsogrutils.cpp.


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