A simple feature sink which proxies feature addition on to another feature sink. More...
#include <qgsfeaturesink.h>
Public Member Functions | |
| QgsProxyFeatureSink (QgsFeatureSink *sink) | |
| Constructs a new QgsProxyFeatureSink which forwards features onto a destination sink. More... | |
| bool | addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=nullptr) override |
| Adds a single feature to the sink. More... | |
| bool | addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=nullptr) override |
| Adds a list of features to the sink. More... | |
| bool | addFeatures (QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=nullptr) override |
| Adds all features from the specified iterator to the sink. More... | |
| QgsFeatureSink * | destinationSink () |
| Returns the destination QgsFeatureSink which the proxy will forward features to. More... | |
 Public Member Functions inherited from QgsFeatureSink | |
| virtual | ~QgsFeatureSink ()=default |
| virtual bool | flushBuffer () |
| Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink's destination. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsFeatureSink | |
| enum | Flag { FastInsert = 1 << 1 } |
| Flags controlling how features are added to a sink. More... | |
| enum | SinkFlag { RegeneratePrimaryKey = 1 << 1 } |
| Flags that can be set on a QgsFeatureSink. More... | |
Detailed Description
A simple feature sink which proxies feature addition on to another feature sink.
This class is designed to allow factory methods which always return new QgsFeatureSink objects. Since it is not always possible to create an entirely new QgsFeatureSink (e.g. if the feature sink is a layer's data provider), a new QgsProxyFeatureSink can instead be returned which forwards features on to the destination sink. The proxy sink can be safely deleted without affecting the destination sink.
- Since
- QGIS 3.0
Definition at line 119 of file qgsfeaturesink.h.
Constructor & Destructor Documentation
◆ QgsProxyFeatureSink()
| QgsProxyFeatureSink::QgsProxyFeatureSink | ( | QgsFeatureSink * | sink | ) |
Constructs a new QgsProxyFeatureSink which forwards features onto a destination sink.
Definition at line 46 of file qgsfeaturesink.cpp.
Member Function Documentation
◆ addFeature()
|
inlineoverridevirtual |
Adds a single feature to the sink.
Feature addition behavior is controlled by the specified flags.
- See also
- addFeatures()
- Returns
- true in case of success and false in case of failure
Reimplemented from QgsFeatureSink.
Reimplemented in QgsProcessingFeatureSink.
Definition at line 127 of file qgsfeaturesink.h.
◆ addFeatures() [1/2]
|
inlineoverridevirtual |
Adds a list of features to the sink.
Feature addition behavior is controlled by the specified flags.
- See also
- addFeature()
- Returns
- true in case of success and false in case of failure
Implements QgsFeatureSink.
Reimplemented in QgsProcessingFeatureSink.
Definition at line 128 of file qgsfeaturesink.h.
◆ addFeatures() [2/2]
|
inlineoverridevirtual |
Adds all features from the specified iterator to the sink.
Feature addition behavior is controlled by the specified flags.
- Returns
- true if all features were added successfully, or false if any feature could not be added
Reimplemented from QgsFeatureSink.
Reimplemented in QgsProcessingFeatureSink.
Definition at line 129 of file qgsfeaturesink.h.
◆ destinationSink()
|
inline |
Returns the destination QgsFeatureSink which the proxy will forward features to.
Definition at line 134 of file qgsfeaturesink.h.
The documentation for this class was generated from the following files:
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/qgsfeaturesink.h
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/qgsfeaturesink.cpp
