QGIS API Documentation  3.21.0-Master (56b4176581)
qgsalgorithmsplitfeaturesbyattributecharacter.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmsplitfeaturesbyattributecharacter.h
3  ---------------------
4  begin : September 2019
5  copyright : (C) 2019 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 QGSALGORITHMSPLITFEATURESBYATTRIBUTECHARACTER_H
19 #define QGSALGORITHMSPLITFEATURESBYATTRIBUTECHARACTER_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
26 #include <QRegularExpression>
27 
29 
33 class QgsSplitFeaturesByAttributeCharacterAlgorithm : public QgsProcessingFeatureBasedAlgorithm
34 {
35 
36  public:
37 
38  QgsSplitFeaturesByAttributeCharacterAlgorithm() = default;
39  QString name() const override;
40  QString displayName() const override;
41  QStringList tags() const override;
42  QString group() const override;
43  QString groupId() const override;
44  QString shortHelpString() const override;
45  QString shortDescription() const override;
46  QList<int> inputLayerTypes() const override;
47  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
49  QgsSplitFeaturesByAttributeCharacterAlgorithm *createInstance() const override SIP_FACTORY;
50  QgsFields outputFields( const QgsFields &inputFields ) const override;
51 
52  protected:
53  QString outputName() const override;
54  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
56  QgsFeatureSink::SinkFlags sinkFlags() const override;
57  private:
58  QString mFieldName;
59  mutable int mFieldIndex = -1;
60  QString mChar;
61  bool mUseRegex = false;
62  QRegularExpression mRegex;
63 
64 };
65 
67 
68 #endif // QGSALGORITHMSPLITFEATURESBYATTRIBUTECHARACTER_H
69 
70 
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
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 shortDescription() const
Returns an optional translated short description of 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 void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QgsProcessing::SourceType outputLayerType() const
Returns the layer type for layers generated by this algorithm, if this is possible to determine in ad...
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.
SourceType
Data source types enum.
Definition: qgsprocessing.h:46
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:834