QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
QgsProxyFeatureSink subclass which reports feature addition errors to a QgsProcessingContext. More...
#include <qgsprocessingutils.h>
Public Member Functions | |
QgsProcessingFeatureSink (QgsFeatureSink *originalSink, const QString &sinkName, QgsProcessingContext &context, bool ownsOriginalSink=false) | |
Constructor for QgsProcessingFeatureSink, accepting an original feature sink originalSink and processing context. | |
~QgsProcessingFeatureSink () override | |
bool | addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override |
Adds a single feature to the sink. | |
bool | addFeatures (QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override |
Adds all features from the specified iterator to the sink. | |
bool | addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override |
Adds a list of features to the sink. | |
Public Member Functions inherited from QgsProxyFeatureSink | |
QgsProxyFeatureSink (QgsFeatureSink *sink) | |
Constructs a new QgsProxyFeatureSink which forwards features onto a destination sink. | |
bool | addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override |
Adds a single feature to the sink. | |
bool | addFeatures (QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override |
Adds all features from the specified iterator to the sink. | |
bool | addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) override |
Adds a list of features to the sink. | |
QgsFeatureSink * | destinationSink () |
Returns the destination QgsFeatureSink which the proxy will forward features to. | |
QString | lastError () const override |
Returns the most recent error encountered by the sink, e.g. | |
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. | |
Additional Inherited Members | |
Public Types inherited from QgsFeatureSink | |
enum | Flag { FastInsert = 1 << 1 , RollBackOnErrors = 1 << 2 } |
Flags controlling how features are added to a sink. More... | |
typedef QFlags< Flag > | Flags |
enum | SinkFlag { RegeneratePrimaryKey = 1 << 1 } |
Flags that can be set on a QgsFeatureSink. More... | |
typedef QFlags< SinkFlag > | SinkFlags |
QgsProxyFeatureSink subclass which reports feature addition errors to a QgsProcessingContext.
Definition at line 780 of file qgsprocessingutils.h.
QgsProcessingFeatureSink::QgsProcessingFeatureSink | ( | QgsFeatureSink * | originalSink, |
const QString & | sinkName, | ||
QgsProcessingContext & | context, | ||
bool | ownsOriginalSink = false |
||
) |
Constructor for QgsProcessingFeatureSink, accepting an original feature sink originalSink and processing context.
Any added features are added to the originalSink, with feature writing errors being reports to context.
The context must exist for the lifetime of this object.
The sinkName is used to identify the destination sink when reporting errors.
Ownership of originalSink is dictated by ownsOriginalSource. If ownsOriginalSink is false
, ownership is not transferred, and callers must ensure that originalSink exists for the lifetime of this object. If ownsOriginalSink is true
, then this object will take ownership of originalSink.
Definition at line 1996 of file qgsprocessingutils.cpp.
|
override |
Definition at line 2003 of file qgsprocessingutils.cpp.
|
overridevirtual |
Adds a single feature to the sink.
Feature addition behavior is controlled by the specified flags.
true
in case of success and false
in case of failure Reimplemented from QgsFeatureSink.
Definition at line 2009 of file qgsprocessingutils.cpp.
|
overridevirtual |
Adds all features from the specified iterator to the sink.
Feature addition behavior is controlled by the specified flags.
true
if all features were added successfully, or false
if any feature could not be added Reimplemented from QgsFeatureSink.
Definition at line 2037 of file qgsprocessingutils.cpp.
|
overridevirtual |
Adds a list of features to the sink.
Feature addition behavior is controlled by the specified flags.
true
in case of success and false
in case of failure Implements QgsFeatureSink.
Definition at line 2023 of file qgsprocessingutils.cpp.