Branch data     Line data    Source code

       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                 :            : 
      26                 :            : ///@cond PRIVATE
      27                 :            : 
      28                 :            : /**
      29                 :            :  * Native add incremental field algorithm.
      30                 :            :  */
      31                 :          0 : class QgsAddIncrementalFieldAlgorithm : public QgsProcessingFeatureBasedAlgorithm
      32                 :            : {
      33                 :            : 
      34                 :            :   public:
      35                 :            : 
      36                 :          0 :     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                 :          0 :     long long mStartValue = 0;
      61                 :          0 :     long long mValue = 0;
      62                 :            :     QString mFieldName;
      63                 :            :     QHash< QgsAttributes, long long > mGroupedValues;
      64                 :            :     mutable QgsFields mFields;
      65                 :            :     QStringList mGroupedFieldNames;
      66                 :            :     QgsAttributeList mGroupedFields;
      67                 :            : 
      68                 :            :     QString mSortExpressionString;
      69                 :          0 :     bool mSortAscending = true;
      70                 :          0 :     bool mSortNullsFirst = false;
      71                 :            : 
      72                 :            : };
      73                 :            : 
      74                 :            : ///@endcond PRIVATE
      75                 :            : 
      76                 :            : #endif // QGSNATIVEALGORITHMS_H
      77                 :            : 
      78                 :            :