QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
qgsalgorithmrefactorfields.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmrefactorfields.h
3 ---------------------------------
4 begin : June 2020
5 copyright : (C) 2020 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 QGSALGORITHMREFACTORFIELDS_H
19#define QGSALGORITHMREFACTORFIELDS_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25#include "qgsdistancearea.h"
26
28
32class QgsRefactorFieldsAlgorithm : public QgsProcessingFeatureBasedAlgorithm
33{
34
35 public:
36
37 QgsRefactorFieldsAlgorithm() = default;
38 QString name() const override;
39 QString displayName() const override;
40 QStringList tags() const override;
41 QString group() const override;
42 QString groupId() const override;
43 QString shortHelpString() const override;
44 QList<int> inputLayerTypes() const override;
45 QgsRefactorFieldsAlgorithm *createInstance() const override SIP_FACTORY;
46 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
47
48 protected:
49
50 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
51 QString outputName() const override;
52 QgsFields outputFields( const QgsFields &inputFields ) const override;
53 Qgis::ProcessingFeatureSourceFlags sourceFlags() const override;
54
55 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
56 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
57
58 private:
59
60 QgsFields mFields;
61 QList< QgsExpression > mExpressions;
62 bool mExpressionsPrepared = false;
63 QgsExpressionContext mExpressionContext;
65 long long mRowNumber = 0;
66
67};
68
70
71#endif // QGSALGORITHMREFACTORFIELDS_H
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3253
A general purpose distance and area calculator, capable of performing ellipsoid based calculations.
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
Base class for all map layer types.
Definition qgsmaplayer.h:75
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Contains information about the context in which a processing algorithm is executed.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
Base class for providing feedback from a processing algorithm.
#define SIP_FACTORY
Definition qgis_sip.h:76
QList< QgsFeature > QgsFeatureList