QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Utilities for working with OGR features and layers. More...
#include <qgsogrutils.h>
Static Public Member Functions | |
static OGRFieldDomainH | convertFieldDomain (const QgsFieldDomain *domain) |
Converts a QGIS field domain definition to an OGR field domain equivalent. | |
static std::unique_ptr< QgsFieldDomain > | convertFieldDomain (OGRFieldDomainH domain) |
Converts an OGR field domain definition to a QgsFieldDomain equivalent. | |
static gdal::relationship_unique_ptr | convertRelationship (const QgsWeakRelation &relation, QString &error) |
Converts a QGIS relation to a GDAL relationship equivalent. | |
static QgsWeakRelation | convertRelationship (GDALRelationshipH relationship, const QString &datasetUri) |
Converts an GDAL relationship definition to a QgsWeakRelation equivalent. | |
static OGRSpatialReferenceH | crsToOGRSpatialReference (const QgsCoordinateReferenceSystem &crs) |
Returns a OGRSpatialReferenceH corresponding to the specified crs object. | |
static QStringList | cStringListToQStringList (char **stringList) |
Converts a c string list to a QStringList. | |
static bool | deleteStyleById (GDALDatasetH hDS, const QString &styleId, QString &errCause) |
Helper function for deleting a style by id from ogr/gdal database datasources. | |
static QVariant | getOgrFeatureAttribute (OGRFeatureH ogrFet, const QgsField &field, int attIndex, QTextCodec *encoding, bool *ok=nullptr) |
Retrieves an attribute value from an OGR feature, using a provided field definition. | |
static QVariant | getOgrFeatureAttribute (OGRFeatureH ogrFet, const QgsFields &fields, int attIndex, QTextCodec *encoding, bool *ok=nullptr) |
Retrieves an attribute value from an OGR feature. | |
static QString | getStyleById (GDALDatasetH hDS, const QString &styleId, QString &errCause) |
Helper function for getting a style by ID from ogr/gdal database datasources. | |
static int | listStyles (GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, QStringList &ids, QStringList &names, QStringList &descriptions, QString &errCause) |
Helper function for listing styles in ogr/gdal database datasources. | |
static QString | loadStoredStyle (GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, QString &styleName, QString &errCause) |
Helper function for loading a stored styles in ogr/gdal database datasources. | |
static QList< QgsVectorDataProvider::NativeType > | nativeFieldTypesForDriver (GDALDriverH driver) |
Returns the list of native field types supported for a driver. | |
static QVariant | OGRFieldtoVariant (const OGRField *value, OGRFieldType type) |
Converts an OGRField value of the specified type into a QVariant. | |
static void | ogrFieldTypeToQVariantType (OGRFieldType ogrType, OGRFieldSubType ogrSubType, QMetaType::Type &variantType, QMetaType::Type &variantSubType) |
Converts an OGR field type and sub type to the best matching QVariant::Type equivalent. | |
static QgsGeometry | ogrGeometryToQgsGeometry (OGRGeometryH geom) |
Converts an OGR geometry representation to a QgsGeometry object. | |
static Qgis::WkbType | ogrGeometryTypeToQgsWkbType (OGRwkbGeometryType ogrGeomType) |
Converts a OGRwkbGeometryType to QgsWkbTypes::Type. | |
static QgsCoordinateReferenceSystem | OGRSpatialReferenceToCrs (OGRSpatialReferenceH srs) |
Returns a QgsCoordinateReferenceSystem corresponding to the specified OGR srs object, or an invalid QgsCoordinateReferenceSystem if srs could not be converted. | |
static QString | OGRSpatialReferenceToWkt (OGRSpatialReferenceH srs) |
Returns a WKT string corresponding to the specified OGR srs object. | |
static int | OGRTZFlagFromQt (const QDateTime &datetime) |
Gets the value of OGRField::Date::TZFlag from the timezone of a QDateTime. | |
static QVariantMap | parseStyleString (const QString &string) |
Parses an OGR style string to a variant map containing the style string components. | |
static QgsFeature | readOgrFeature (OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding) |
Reads an OGR feature and converts it to a QgsFeature. | |
static bool | readOgrFeatureAttributes (OGRFeatureH ogrFet, const QgsFields &fields, QgsFeature &feature, QTextCodec *encoding) |
Reads all attributes from an OGR feature into a QgsFeature. | |
static bool | readOgrFeatureGeometry (OGRFeatureH ogrFet, QgsFeature &feature) |
Reads the geometry from an OGR feature into a QgsFeature. | |
static QgsFields | readOgrFields (OGRFeatureH ogrFet, QTextCodec *encoding) |
Reads an OGR feature and returns a corresponding fields collection. | |
static QString | readShapefileEncoding (const QString &path) |
Reads the encoding of the shapefile at the specified path (where path is the location of the ".shp" file). | |
static QString | readShapefileEncodingFromCpg (const QString &path) |
Reads the encoding of the shapefile at the specified path (where path is the location of the ".shp" file), from the CPG specified encoding. | |
static QString | readShapefileEncodingFromLdid (const QString &path) |
Reads the encoding of the shapefile at the specified path (where path is the location of the ".shp" file), from the DBF LDID encoding. | |
static bool | saveStyle (GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, const QString &qmlStyle, const QString &sldStyle, const QString &styleName, const QString &styleDescription, const QString &uiFileContent, bool useAsDefault, QString &errCause) |
Helper function for saving a style to ogr/gdal database datasources. | |
static QgsFeatureList | stringToFeatureList (const QString &string, const QgsFields &fields, QTextCodec *encoding) |
Attempts to parse a string representing a collection of features using OGR. | |
static QgsFields | stringToFields (const QString &string, QTextCodec *encoding) |
Attempts to retrieve the fields from a string representing a collection of features using OGR. | |
static QVariant | stringToVariant (OGRFieldType type, OGRFieldSubType subType, const QString &string) |
Converts a string to a variant, using the provider OGR field type and subType to determine the most appropriate variant type. | |
static bool | styleExists (GDALDatasetH hDS, const QString &layerName, const QString &geomColumn, const QString &styleId, QString &errorCause) |
Helper function for checking whether a style exists in ogr/gdal database datasources. | |
static std::unique_ptr< QgsSymbol > | symbolFromStyleString (const QString &string, Qgis::SymbolType type) |
Creates a new QgsSymbol matching an OGR style string. | |
static std::unique_ptr< OGRField > | variantToOGRField (const QVariant &value, OGRFieldType type) |
Converts a QVariant to an OGRField value of specified type. | |
static void | variantTypeToOgrFieldType (QMetaType::Type variantType, OGRFieldType &ogrType, OGRFieldSubType &ogrSubType) |
Converts an QVariant type to the best matching OGR field type and sub type. | |
Utilities for working with OGR features and layers.
Contains helper utilities for assisting work with both OGR features and layers.
Definition at line 191 of file qgsogrutils.h.
|
static |
Converts a QGIS field domain definition to an OGR field domain equivalent.
Definition at line 2214 of file qgsogrutils.cpp.
|
static |
Converts an OGR field domain definition to a QgsFieldDomain equivalent.
Definition at line 2121 of file qgsogrutils.cpp.
|
static |
Converts a QGIS relation to a GDAL relationship equivalent.
Definition at line 2450 of file qgsogrutils.cpp.
|
static |
Converts an GDAL relationship definition to a QgsWeakRelation equivalent.
Definition at line 2326 of file qgsogrutils.cpp.
|
static |
Returns a OGRSpatialReferenceH corresponding to the specified crs object.
Definition at line 1178 of file qgsogrutils.cpp.
|
static |
Converts a c string list to a QStringList.
Presumes a null terminated string list.
Definition at line 1114 of file qgsogrutils.cpp.
|
static |
Helper function for deleting a style by id from ogr/gdal database datasources.
Definition at line 2761 of file qgsogrutils.cpp.
|
static |
Retrieves an attribute value from an OGR feature, using a provided field definition.
ogrFet | OGR feature handle |
field | definition of corresponding field |
attIndex | index of attribute to retrieve from ogrFet |
encoding | text encoding |
ok | optional storage for success of retrieval |
Definition at line 519 of file qgsogrutils.cpp.
|
static |
Retrieves an attribute value from an OGR feature.
ogrFet | OGR feature handle |
fields | fields collection corresponding to feature |
attIndex | index of attribute to retrieve |
encoding | text encoding |
ok | optional storage for success of retrieval |
Definition at line 506 of file qgsogrutils.cpp.
|
static |
Helper function for getting a style by ID from ogr/gdal database datasources.
Definition at line 2727 of file qgsogrutils.cpp.
|
static |
Helper function for listing styles in ogr/gdal database datasources.
Definition at line 2609 of file qgsogrutils.cpp.
|
static |
Helper function for loading a stored styles in ogr/gdal database datasources.
Definition at line 2788 of file qgsogrutils.cpp.
|
static |
Returns the list of native field types supported for a driver.
Definition at line 2001 of file qgsogrutils.cpp.
|
static |
Converts an OGRField value of the specified type into a QVariant.
Definition at line 144 of file qgsogrutils.cpp.
|
static |
Converts an OGR field type and sub type to the best matching QVariant::Type equivalent.
ogrType | OGR field type |
ogrSubType | OGR field sub type |
variantType | will be set to matching QVariant type |
variantSubType | will be set to matching QVariant sub type, for list, map and other complex OGR field types. |
Definition at line 1825 of file qgsogrutils.cpp.
|
static |
Converts an OGR geometry representation to a QgsGeometry object.
geom | OGR geometry handle |
Definition at line 961 of file qgsogrutils.cpp.
|
static |
Converts a OGRwkbGeometryType to QgsWkbTypes::Type.
Definition at line 875 of file qgsogrutils.cpp.
|
static |
Returns a QgsCoordinateReferenceSystem corresponding to the specified OGR srs object, or an invalid QgsCoordinateReferenceSystem if srs could not be converted.
Definition at line 1145 of file qgsogrutils.cpp.
|
static |
Returns a WKT string corresponding to the specified OGR srs object.
The WKT string format will be selected using the most appropriate format (usually WKT2 if GDAL 3 is available).
Definition at line 1129 of file qgsogrutils.cpp.
|
static |
Gets the value of OGRField::Date::TZFlag from the timezone of a QDateTime.
Definition at line 229 of file qgsogrutils.cpp.
|
static |
Parses an OGR style string to a variant map containing the style string components.
Definition at line 1259 of file qgsogrutils.cpp.
|
static |
Reads an OGR feature and converts it to a QgsFeature.
ogrFet | OGR feature handle |
fields | fields collection corresponding to feature |
encoding | text encoding |
Definition at line 424 of file qgsogrutils.cpp.
|
static |
Reads all attributes from an OGR feature into a QgsFeature.
ogrFet | OGR feature handle |
fields | fields collection corresponding to feature |
feature | QgsFeature to store attributes in |
encoding | text encoding |
true
if attribute read was successful Definition at line 745 of file qgsogrutils.cpp.
|
static |
Reads the geometry from an OGR feature into a QgsFeature.
ogrFet | OGR feature handle |
feature | QgsFeature to store geometry in |
true
if geometry read was successful Definition at line 766 of file qgsogrutils.cpp.
|
static |
Reads an OGR feature and returns a corresponding fields collection.
ogrFet | OGR feature handle |
encoding | text encoding |
Definition at line 449 of file qgsogrutils.cpp.
|
static |
Reads the encoding of the shapefile at the specified path (where path is the location of the ".shp" file).
This method considers both the CPG specified encoding and the DBF LDID encoding (priority goes to CPG based encoding)
Definition at line 1236 of file qgsogrutils.cpp.
|
static |
Reads the encoding of the shapefile at the specified path (where path is the location of the ".shp" file), from the CPG specified encoding.
Return an empty string if CPG based encoding was not found.
Definition at line 1245 of file qgsogrutils.cpp.
|
static |
Reads the encoding of the shapefile at the specified path (where path is the location of the ".shp" file), from the DBF LDID encoding.
Return an empty string if LDID based encoding was not found.
Definition at line 1252 of file qgsogrutils.cpp.
|
static |
Helper function for saving a style to ogr/gdal database datasources.
Definition at line 2843 of file qgsogrutils.cpp.
|
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.
string | string to parse |
fields | fields collection to use for parsed features ( |
encoding | text encoding |
Definition at line 1032 of file qgsogrutils.cpp.
|
static |
Attempts to retrieve the fields from a string representing a collection of features using OGR.
string | string to parse |
encoding | text encoding |
Definition at line 1074 of file qgsogrutils.cpp.
|
static |
Converts a string to a variant, using the provider OGR field type and subType to determine the most appropriate variant type.
Definition at line 1950 of file qgsogrutils.cpp.
|
static |
Helper function for checking whether a style exists in ogr/gdal database datasources.
Definition at line 2698 of file qgsogrutils.cpp.
|
static |
Creates a new QgsSymbol matching an OGR style string.
Definition at line 1306 of file qgsogrutils.cpp.
|
static |
Converts a QVariant to an OGRField value of specified type.
Returns nullptr in case of error
Definition at line 236 of file qgsogrutils.cpp.
|
static |
Converts an QVariant type to the best matching OGR field type and sub type.
variantType | QVariant field type |
ogrType | will be set to matching OGR type |
ogrSubType | will be set to matching OGR sub type |
Definition at line 1898 of file qgsogrutils.cpp.