QGIS API Documentation  3.11.0-Master (12c410c3f4)
qgsfeaturesink.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsfeaturesink.h
3  ----------------
4  begin : April 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
7  ***************************************************************************/
8 
9 /***************************************************************************
10  * *
11  * This program is free software; you can redistribute it and/or modify *
12  * it under the terms of the GNU General Public License as published by *
13  * the Free Software Foundation; either version 2 of the License, or *
14  * (at your option) any later version. *
15  * *
16  ***************************************************************************/
17 
18 #ifndef QGSFEATURESINK_H
19 #define QGSFEATURESINK_H
20 
21 #include "qgis_core.h"
22 #include "qgis_sip.h"
23 #include "qgsfeature.h"
24 #include "qgsfeatureiterator.h"
25 
33 class CORE_EXPORT QgsFeatureSink
34 {
35  public:
36 
42  enum SinkFlag
43  {
44 
55  RegeneratePrimaryKey = 1 << 1,
56  };
57  Q_DECLARE_FLAGS( SinkFlags, SinkFlag )
58 
59 
60  enum Flag
61  {
62 
70  FastInsert = 1 << 1,
71  };
72  Q_DECLARE_FLAGS( Flags, Flag )
73 
74  virtual ~QgsFeatureSink() = default;
75 
81  virtual bool addFeature( QgsFeature &feature, QgsFeatureSink::Flags flags = nullptr );
82 
88  virtual bool addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags = nullptr ) = 0;
89 
94  virtual bool addFeatures( QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags = nullptr );
95 
100  virtual bool flushBuffer() { return true; }
101 };
102 
103 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsFeatureSink::Flags )
104 
105 
106 
119 class CORE_EXPORT QgsProxyFeatureSink : public QgsFeatureSink
120 {
121  public:
122 
127  bool addFeature( QgsFeature &feature, QgsFeatureSink::Flags flags = nullptr ) override { return mSink->addFeature( feature, flags ); }
128  bool addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags = nullptr ) override { return mSink->addFeatures( features, flags ); }
129  bool addFeatures( QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags = nullptr ) override { return mSink->addFeatures( iterator, flags ); }
130 
134  QgsFeatureSink *destinationSink() { return mSink; }
135 
136  private:
137 
138  QgsFeatureSink *mSink = nullptr;
139 };
140 
142 
143 #endif // QGSFEATURESINK_H
Wrapper for iterator of features from vector data provider or vector layer.
A simple feature sink which proxies feature addition on to another feature sink.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:571
An interface for objects which accept features via addFeature(s) methods.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
bool addFeatures(QgsFeatureList &features, QgsFeatureSink::Flags flags=nullptr) override
Adds a list of features to the sink.
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
bool addFeatures(QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=nullptr) override
Adds all features from the specified iterator to the sink.
virtual bool flushBuffer()
Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to...
SinkFlag
Flags that can be set on a QgsFeatureSink.
Flag
Flags controlling how features are added to a sink.
bool addFeature(QgsFeature &feature, QgsFeatureSink::Flags flags=nullptr) override
Adds a single feature to the sink.
QgsFeatureSink * destinationSink()
Returns the destination QgsFeatureSink which the proxy will forward features to.