QGIS API Documentation  3.23.0-Master (eb871beae0)
qgsalgorithmaddincrementalfield.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmaddincrementalfield.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 QGSALGORITHMADDINCREMENTALFIELD_H
19 #define QGSALGORITHMADDINCREMENTALFIELD_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsAddIncrementalFieldAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
33 
34  public:
35 
36  QgsAddIncrementalFieldAlgorithm() = default;
37  QString name() const override;
38  QString displayName() const override;
39  QStringList tags() const override;
40  QString group() const override;
41  QString groupId() const override;
42  QString shortHelpString() const override;
43  QList<int> inputLayerTypes() const override;
44  QgsAddIncrementalFieldAlgorithm *createInstance() const override SIP_FACTORY;
45 
46  protected:
47 
48  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
49  QString outputName() const override;
50  QgsFields outputFields( const QgsFields &inputFields ) const override;
51  QgsProcessingFeatureSource::Flag sourceFlags() const override;
52 
53  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54  QgsFeatureRequest request() const override;
55  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
56  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
57 
58  private:
59 
60  long long mStartValue = 0;
61  long long mModulusValue = 0;
62  long long mValue = 0;
63  QString mFieldName;
64  QHash< QgsAttributes, long long > mGroupedValues;
65  mutable QgsFields mFields;
66  QStringList mGroupedFieldNames;
67  QgsAttributeList mGroupedFields;
68 
69  QString mSortExpressionString;
70  bool mSortAscending = true;
71  bool mSortNullsFirst = false;
72 
73 };
74 
76 
77 #endif // QGSNATIVEALGORITHMS_H
78 
79 
This class wraps a request for features to a vector layer (or directly its vector data provider).
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Container of fields for a vector layer.
Definition: qgsfields.h:45
Base class for all map layer types.
Definition: qgsmaplayer.h:73
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 QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
Base class for providing feedback from a processing algorithm.
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834
QList< int > QgsAttributeList
Definition: qgsfield.h:26