QGIS API Documentation  3.20.0-Odense (decaadbb31)
qgsogrutils.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsogrutils.h
3  -------------
4  begin : February 2016
5  copyright : (C) 2016 Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSOGRUTILS_H
17 #define QGSOGRUTILS_H
18 
19 #define SIP_NO_FILE
20 
21 #include "qgis_core.h"
22 #include "qgsfeature.h"
23 
24 #include <ogr_api.h>
25 #include <gdal.h>
26 #include <gdalwarper.h>
27 #include "cpl_conv.h"
28 #include "cpl_string.h"
29 
30 class QTextCodec;
31 
32 namespace gdal
33 {
34 
39  {
40 
44  void CORE_EXPORT operator()( OGRDataSourceH source );
45 
46  };
47 
52  {
53 
57  void CORE_EXPORT operator()( OGRGeometryH geometry );
58 
59  };
60 
65  {
66 
70  void CORE_EXPORT operator()( OGRFieldDefnH definition );
71 
72  };
73 
78  {
79 
83  void CORE_EXPORT operator()( OGRFeatureH feature );
84 
85  };
86 
91  {
92 
96  void CORE_EXPORT operator()( GDALDatasetH datasource );
97 
98  };
99 
104  {
105 
109  void CORE_EXPORT operator()( GDALWarpOptions *options );
110 
111  };
112 
116  using ogr_datasource_unique_ptr = std::unique_ptr< std::remove_pointer<OGRDataSourceH>::type, OGRDataSourceDeleter >;
117 
121  using ogr_geometry_unique_ptr = std::unique_ptr< std::remove_pointer<OGRGeometryH>::type, OGRGeometryDeleter >;
122 
126  using ogr_field_def_unique_ptr = std::unique_ptr< std::remove_pointer<OGRFieldDefnH>::type, OGRFldDeleter >;
127 
131  using ogr_feature_unique_ptr = std::unique_ptr< std::remove_pointer<OGRFeatureH>::type, OGRFeatureDeleter >;
132 
136  using dataset_unique_ptr = std::unique_ptr< std::remove_pointer<GDALDatasetH>::type, GDALDatasetCloser >;
137 
146  void CORE_EXPORT fast_delete_and_close( dataset_unique_ptr &dataset, GDALDriverH driver, const QString &path );
147 
151  using warp_options_unique_ptr = std::unique_ptr< GDALWarpOptions, GDALWarpOptionsDeleter >;
152 }
153 
163 class CORE_EXPORT QgsOgrUtils
164 {
165  public:
166 
171  static QVariant OGRFieldtoVariant( const OGRField *value, OGRFieldType type );
172 
180  static QgsFeature readOgrFeature( OGRFeatureH ogrFet, const QgsFields &fields, QTextCodec *encoding );
181 
188  static QgsFields readOgrFields( OGRFeatureH ogrFet, QTextCodec *encoding );
189 
200  static QVariant getOgrFeatureAttribute( OGRFeatureH ogrFet, const QgsFields &fields, int attIndex, QTextCodec *encoding, bool *ok = nullptr );
201 
214  static QVariant getOgrFeatureAttribute( OGRFeatureH ogrFet, const QgsField &field, int attIndex, QTextCodec *encoding, bool *ok = nullptr );
215 
225  static bool readOgrFeatureAttributes( OGRFeatureH ogrFet, const QgsFields &fields, QgsFeature &feature, QTextCodec *encoding );
226 
235  static bool readOgrFeatureGeometry( OGRFeatureH ogrFet, QgsFeature &feature );
236 
244  static QgsGeometry ogrGeometryToQgsGeometry( OGRGeometryH geom );
245 
255  static QgsFeatureList stringToFeatureList( const QString &string, const QgsFields &fields, QTextCodec *encoding );
256 
264  static QgsFields stringToFields( const QString &string, QTextCodec *encoding );
265 
271  static QStringList cStringListToQStringList( char **stringList );
272 
278  static QgsWkbTypes::Type ogrGeometryTypeToQgsWkbType( OGRwkbGeometryType ogrGeomType );
279 
287  static QString OGRSpatialReferenceToWkt( OGRSpatialReferenceH srs );
288 
295  static QgsCoordinateReferenceSystem OGRSpatialReferenceToCrs( OGRSpatialReferenceH srs );
296 
308  static QString readShapefileEncoding( const QString &path );
309 
319  static QString readShapefileEncodingFromCpg( const QString &path );
320 
330  static QString readShapefileEncodingFromLdid( const QString &path );
331 
337  static QVariantMap parseStyleString( const QString &string );
338 
344  static std::unique_ptr< QgsSymbol > symbolFromStyleString( const QString &string, Qgis::SymbolType type ) SIP_FACTORY;
345 };
346 
347 #endif // QGSOGRUTILS_H
SymbolType
Symbol types.
Definition: qgis.h:168
This class represents a coordinate reference system (CRS).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Encapsulate a field in an attribute table or data source.
Definition: qgsfield.h:51
Container of fields for a vector layer.
Definition: qgsfields.h:45
A geometry is the spatial representation of a feature.
Definition: qgsgeometry.h:124
Utilities for working with OGR features and layers.
Definition: qgsogrutils.h:164
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:70
void CORE_EXPORT fast_delete_and_close(dataset_unique_ptr &dataset, GDALDriverH driver, const QString &path)
Performs a fast close of an unwanted GDAL dataset handle by deleting the underlying data store.
Definition: qgsogrutils.cpp:78
std::unique_ptr< std::remove_pointer< OGRFeatureH >::type, OGRFeatureDeleter > ogr_feature_unique_ptr
Scoped OGR feature.
Definition: qgsogrutils.h:131
std::unique_ptr< std::remove_pointer< GDALDatasetH >::type, GDALDatasetCloser > dataset_unique_ptr
Scoped GDAL dataset.
Definition: qgsogrutils.h:136
std::unique_ptr< std::remove_pointer< OGRDataSourceH >::type, OGRDataSourceDeleter > ogr_datasource_unique_ptr
Scoped OGR data source.
Definition: qgsogrutils.h:116
std::unique_ptr< std::remove_pointer< OGRFieldDefnH >::type, OGRFldDeleter > ogr_field_def_unique_ptr
Scoped OGR field definition.
Definition: qgsogrutils.h:126
std::unique_ptr< std::remove_pointer< OGRGeometryH >::type, OGRGeometryDeleter > ogr_geometry_unique_ptr
Scoped OGR geometry.
Definition: qgsogrutils.h:121
std::unique_ptr< GDALWarpOptions, GDALWarpOptionsDeleter > warp_options_unique_ptr
Scoped GDAL warp options.
Definition: qgsogrutils.h:151
#define SIP_FACTORY
Definition: qgis_sip.h:76
void * GDALDatasetH
void * OGRSpatialReferenceH
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:736
const QgsField & field
Definition: qgsfield.h:463
Closes and cleanups GDAL dataset.
Definition: qgsogrutils.h:91
void CORE_EXPORT operator()(GDALDatasetH datasource)
Destroys an gdal dataset, using the correct gdal calls.
Definition: qgsogrutils.cpp:73
Closes and cleanups GDAL warp options.
Definition: qgsogrutils.h:104
void CORE_EXPORT operator()(GDALWarpOptions *options)
Destroys GDAL warp options, using the correct gdal calls.
Definition: qgsogrutils.cpp:98
Destroys OGR data sources.
Definition: qgsogrutils.h:39
void CORE_EXPORT operator()(OGRDataSourceH source)
Destroys an OGR data source, using the correct gdal calls.
Definition: qgsogrutils.cpp:52
Destroys OGR feature.
Definition: qgsogrutils.h:78
void CORE_EXPORT operator()(OGRFeatureH feature)
Destroys an OGR feature, using the correct gdal calls.
Definition: qgsogrutils.cpp:68
Destroys OGR field definition.
Definition: qgsogrutils.h:65
void CORE_EXPORT operator()(OGRFieldDefnH definition)
Destroys an OGR field definition, using the correct gdal calls.
Definition: qgsogrutils.cpp:63
Destroys OGR geometries.
Definition: qgsogrutils.h:52
void CORE_EXPORT operator()(OGRGeometryH geometry)
Destroys an OGR geometry, using the correct gdal calls.
Definition: qgsogrutils.cpp:58