QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgsmemoryprovider.h
Go to the documentation of this file.
1 /***************************************************************************
2  memoryprovider.h - provider with storage in memory
3  ------------------
4  begin : June 2008
5  copyright : (C) 2008 by Martin Dobias
6  email : wonder dot sk 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 #define SIP_NO_FILE
17 
18 #include "qgsvectordataprovider.h"
20 #include "qgsfields.h"
21 
23 typedef QMap<QgsFeatureId, QgsFeature> QgsFeatureMap;
24 
25 class QgsSpatialIndex;
26 
27 class QgsMemoryFeatureIterator;
28 
29 class QgsMemoryProvider final: public QgsVectorDataProvider
30 {
31  Q_OBJECT
32 
33  public:
34  explicit QgsMemoryProvider( const QString &uri, const QgsVectorDataProvider::ProviderOptions &coordinateTransformContext );
35 
36  ~QgsMemoryProvider() override;
37 
39  static QString providerKey();
41  static QString providerDescription();
42 
47  static QgsMemoryProvider *createProvider( const QString &uri, const QgsVectorDataProvider::ProviderOptions &coordinateTransformContext );
48 
49  /* Implementation of functions from QgsVectorDataProvider */
50 
51  QgsAbstractFeatureSource *featureSource() const override;
52 
53  QString dataSourceUri( bool expandAuthConfig = true ) const override;
54  QString storageType() const override;
55  QgsFeatureIterator getFeatures( const QgsFeatureRequest &request ) const override;
56  QgsWkbTypes::Type wkbType() const override;
57  long featureCount() const override;
58  QgsFields fields() const override;
59  bool addFeatures( QgsFeatureList &flist, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() ) override;
60  bool deleteFeatures( const QgsFeatureIds &id ) override;
61  bool addAttributes( const QList<QgsField> &attributes ) override;
62  bool renameAttributes( const QgsFieldNameMap &renamedAttributes ) override;
63  bool deleteAttributes( const QgsAttributeIds &attributes ) override;
64  bool changeAttributeValues( const QgsChangedAttributesMap &attr_map ) override;
65  bool changeGeometryValues( const QgsGeometryMap &geometry_map ) override;
66  QString subsetString() const override;
67  bool setSubsetString( const QString &theSQL, bool updateFeatureCount = true ) override;
68  bool supportsSubsetString() const override { return true; }
69  bool createSpatialIndex() override;
71  QgsVectorDataProvider::Capabilities capabilities() const override;
72  bool truncate() override;
73 
74  /* Implementation of functions from QgsDataProvider */
75 
76  QString name() const override;
77  QString description() const override;
78  QgsRectangle extent() const override;
79  void updateExtents() override;
80  bool isValid() const override;
81  QgsCoordinateReferenceSystem crs() const override;
82  void handlePostCloneOperations( QgsVectorDataProvider *source ) override;
83 
84  private:
85  // Coordinate reference system
87 
88  // fields
89  QgsFields mFields;
90  QgsWkbTypes::Type mWkbType;
91  mutable QgsRectangle mExtent;
92 
93  // features
94  QgsFeatureMap mFeatures;
95  QgsFeatureId mNextFeatureId;
96 
97  // indexing
98  QgsSpatialIndex *mSpatialIndex = nullptr;
99 
100  QString mSubsetString;
101 
102  friend class QgsMemoryFeatureSource;
103 };
104 
qgsfields.h
QgsAttributeIds
QSet< int > QgsAttributeIds
Definition: qgsvectordataprovider.h:39
QgsFeatureSource::hasSpatialIndex
virtual SpatialIndexPresence hasSpatialIndex() const
Returns an enum value representing the presence of a valid spatial index on the source,...
Definition: qgsfeaturesource.cpp:190
QgsVectorDataProvider::deleteFeatures
virtual bool deleteFeatures(const QgsFeatureIds &id)
Deletes one or more features from the provider.
Definition: qgsvectordataprovider.cpp:92
QgsVectorDataProvider::createSpatialIndex
virtual bool createSpatialIndex()
Creates a spatial index on the datasource (if supported by the provider type).
Definition: qgsvectordataprovider.cpp:180
QgsDataProvider::supportsSubsetString
virtual bool supportsSubsetString() const
Returns true if the provider supports setting of subset strings.
Definition: qgsdataprovider.h:244
QgsDataProvider::ProviderOptions
Setting options for creating vector data providers.
Definition: qgsdataprovider.h:104
QgsVectorDataProvider::handlePostCloneOperations
virtual void handlePostCloneOperations(QgsVectorDataProvider *source)
Handles any post-clone operations required after this vector data provider was cloned from the source...
Definition: qgsvectordataprovider.cpp:867
QgsVectorDataProvider::fields
QgsFields fields() const override=0
Returns the fields associated with this data provider.
QgsDataProvider::setSubsetString
virtual bool setSubsetString(const QString &subset, bool updateFeatureCount=true)
Set the subset string used to create a subset of features in the layer.
Definition: qgsdataprovider.h:232
QgsVectorDataProvider::changeAttributeValues
virtual bool changeAttributeValues(const QgsChangedAttributesMap &attr_map)
Changes attribute values of existing features.
Definition: qgsvectordataprovider.cpp:130
QgsFields
Definition: qgsfields.h:44
QgsWkbTypes::Type
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:68
QgsChangedAttributesMap
QMap< QgsFeatureId, QgsAttributeMap > QgsChangedAttributesMap
Definition: qgsfeature.h:558
QgsDataProvider::dataSourceUri
virtual QString dataSourceUri(bool expandAuthConfig=false) const
Gets the data source specification.
Definition: qgsdataprovider.h:142
QgsRectangle
Definition: qgsrectangle.h:41
QgsDataProvider::description
virtual QString description() const =0
Returns description.
QgsFeatureRequest
Definition: qgsfeaturerequest.h:75
QgsVectorDataProvider::capabilities
virtual QgsVectorDataProvider::Capabilities capabilities() const
Returns flags containing the supported capabilities.
Definition: qgsvectordataprovider.cpp:191
QgsVectorDataProvider::featureCount
long featureCount() const override=0
Number of features in the layer.
QgsVectorDataProvider::changeGeometryValues
virtual bool changeGeometryValues(const QgsGeometryMap &geometry_map)
Changes geometries of existing features.
Definition: qgsvectordataprovider.cpp:162
QgsVectorDataProvider::truncate
virtual bool truncate()
Removes all features from the layer.
Definition: qgsvectordataprovider.cpp:98
QgsVectorDataProvider::featureSource
virtual QgsAbstractFeatureSource * featureSource() const =0
Returns feature source object that can be used for querying provider's data.
QgsFeatureSource::SpatialIndexPresence
SpatialIndexPresence
Enumeration of spatial index presence states.
Definition: qgsfeaturesource.h:187
QgsAbstractFeatureSource
Definition: qgsfeaturerequest.h:742
QgsVectorDataProvider::renameAttributes
virtual bool renameAttributes(const QgsFieldNameMap &renamedAttributes)
Renames existing attributes.
Definition: qgsvectordataprovider.cpp:124
qgsvectordataprovider.h
QgsFeatureList
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:572
QgsVectorDataProvider::storageType
virtual QString storageType() const
Returns the permanent storage type for this layer as a friendly name.
Definition: qgsvectordataprovider.cpp:44
QgsSpatialIndex
Definition: qgsspatialindex.h:67
QgsFeatureMap
QMap< QgsFeatureId, QgsFeature > QgsFeatureMap
Definition: qgsvectorlayereditbuffer.h:30
QgsVectorDataProvider::getFeatures
QgsFeatureIterator getFeatures(const QgsFeatureRequest &request=QgsFeatureRequest()) const override=0
Query the provider for features specified in request.
QgsFeatureIds
QSet< QgsFeatureId > QgsFeatureIds
Definition: qgsfeatureid.h:34
QgsCoordinateReferenceSystem
Definition: qgscoordinatereferencesystem.h:206
QgsVectorDataProvider::deleteAttributes
virtual bool deleteAttributes(const QgsAttributeIds &attributes)
Deletes existing attributes from the provider.
Definition: qgsvectordataprovider.cpp:118
QgsVectorDataProvider::addFeatures
bool addFeatures(QgsFeatureList &flist, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override
Adds a list of features to the sink.
Definition: qgsvectordataprovider.cpp:85
QgsDataProvider::extent
virtual QgsRectangle extent() const =0
Returns the extent of the layer.
QgsFieldNameMap
QMap< int, QString > QgsFieldNameMap
Definition: qgsattributes.h:44
QgsVectorDataProvider::addAttributes
virtual bool addAttributes(const QList< QgsField > &attributes)
Adds new attributes to the provider.
Definition: qgsvectordataprovider.cpp:112
QgsGeometryMap
QMap< QgsFeatureId, QgsGeometry > QgsGeometryMap
Definition: qgsfeature.h:567
QgsVectorDataProvider
Definition: qgsvectordataprovider.h:58
QgsDataProvider::subsetString
virtual QString subsetString() const
Returns the subset definition string (typically sql) currently in use by the layer and used by the pr...
Definition: qgsdataprovider.h:252
QgsDataProvider::name
virtual QString name() const =0
Returns a provider name.
QgsFeatureIterator
Definition: qgsfeatureiterator.h:263
qgscoordinatereferencesystem.h
QgsVectorDataProvider::wkbType
QgsWkbTypes::Type wkbType() const override=0
Returns the geometry type which is returned by this layer.
QgsDataProvider::isValid
virtual bool isValid() const =0
Returns true if this is a valid layer.
QgsDataProvider::updateExtents
virtual void updateExtents()
Update the extents of the layer.
Definition: qgsdataprovider.h:220
QgsFeatureId
qint64 QgsFeatureId
Definition: qgsfeatureid.h:25
QgsDataProvider::crs
virtual QgsCoordinateReferenceSystem crs() const =0
Returns the coordinate system for the data source.