QGIS API Documentation  3.14.0-Pi (9f7028fd23)
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 = QgsFeatureSink::Flags() );
82 
88  virtual bool addFeatures( QgsFeatureList &features, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() ) = 0;
89 
94  virtual bool addFeatures( QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags = QgsFeatureSink::Flags() );
95 
100  virtual bool flushBuffer() { return true; }
101 };
102 
103 Q_DECLARE_OPERATORS_FOR_FLAGS( QgsFeatureSink::Flags )
104 
106 
107 #endif // QGSFEATURESINK_H
QgsFeatureSink::Flag
Flag
Flags controlling how features are added to a sink.
Definition: qgsfeaturesink.h:60
qgsfeatureiterator.h
qgsfeature.h
Q_DECLARE_METATYPE
Q_DECLARE_METATYPE(QgsMeshTimeSettings)
qgis_sip.h
QgsFeatureList
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:572
QgsFeatureSink::flushBuffer
virtual bool flushBuffer()
Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to...
Definition: qgsfeaturesink.h:100
QgsFeature
Definition: qgsfeature.h:55
QgsFeatureSink::SinkFlag
SinkFlag
Flags that can be set on a QgsFeatureSink.
Definition: qgsfeaturesink.h:42
QgsFeatureIterator
Definition: qgsfeatureiterator.h:263
QgsFeatureSink
Definition: qgsfeaturesink.h:33