QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
|
Go to the documentation of this file.
18 #ifndef QGSALGORITHMREFACTORFIELDS_H
19 #define QGSALGORITHMREFACTORFIELDS_H
36 QgsRefactorFieldsAlgorithm() =
default;
37 QString
name()
const override;
39 QStringList
tags()
const override;
40 QString
group()
const override;
41 QString
groupId()
const override;
48 void initParameters(
const QVariantMap &configuration = QVariantMap() )
override;
60 QList< QgsExpression > mExpressions;
61 bool mExpressionsPrepared =
false;
64 long long mRowNumber = 0;
70 #endif // QGSALGORITHMREFACTORFIELDS_H
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
Base class for providing feedback from a processing algorithm.
Container of fields for a vector layer.
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
bool supportInPlaceEdit(const QgsMapLayer *layer) const override
Checks whether this algorithm supports in-place editing on the given layer Default implementation for...
virtual bool prepareAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
virtual QgsProcessingFeatureSource::Flag sourceFlags() const
Returns the processing feature source flags to be used in the algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
Contains information about the context in which a processing algorithm is executed.
QList< QgsFeature > QgsFeatureList
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
virtual QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by the algorithm.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
Base class for all map layer types.
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...