QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsalgorithmcategorizeusingstyle.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmcategorizeusingstyle.h
3  ---------------------
4  begin : August 2018
5  copyright : (C) 2018 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 QGSALGORITHMCATEGORIZEUSINGSTYLE_H
19 #define QGSALGORITHMCATEGORIZEUSINGSTYLE_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
29 
33 class QgsCategorizeUsingStyleAlgorithm : public QgsProcessingAlgorithm
34 {
35 
36  public:
37 
38  QgsCategorizeUsingStyleAlgorithm();
39  ~QgsCategorizeUsingStyleAlgorithm() override;
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QString name() const override;
42  QString displayName() const override;
43  QStringList tags() const override;
44  QString group() const override;
45  QString groupId() const override;
46  QString shortHelpString() const override;
47  QString shortDescription() const override;
48  QgsCategorizeUsingStyleAlgorithm *createInstance() const override SIP_FACTORY;
49 
50  protected:
51 
52  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53  QVariantMap processAlgorithm( const QVariantMap &parameters,
54  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55 
56  private:
57 
58  QString mField;
59  QString mLayerId;
60  QString mLayerName;
61  QgsWkbTypes::GeometryType mLayerGeometryType = QgsWkbTypes::UnknownGeometry;
62  QgsFields mLayerFields;
63  QgsExpression mExpression;
64  QgsExpressionContext mExpressionContext;
65  QgsFeatureIterator mIterator;
67 };
68 
70 
71 #endif // QGSALGORITHMCATEGORIZEUSINGSTYLE_H
72 
73 
Class for parsing and evaluation of expressions (formerly called "search strings").
Wrapper for iterator of features from vector data provider or vector layer.
Base class for providing feedback from a processing algorithm.
Handles storage of information regarding WKB types and their properties.
Definition: qgswkbtypes.h:40
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
Container of fields for a vector layer.
Definition: qgsfields.h:42
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:79
#define SIP_FACTORY
Definition: qgis_sip.h:69
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
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 QString group() const
Returns the name of the group this algorithm belongs to.
Contains information about the context in which a processing algorithm is executed.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.