QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsalgorithmextractbyattribute.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmextractbyattribute.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 QGSALGORITHMEXTRACTBYATTRIBUTE_H
19 #define QGSALGORITHMEXTRACTBYATTRIBUTE_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsExtractByAttributeAlgorithm : public QgsProcessingAlgorithm
32 {
33 
34  public:
35 
36  enum Operation
37  {
38  Equals,
39  NotEquals,
40  GreaterThan,
41  GreaterThanEqualTo,
42  LessThan,
43  LessThanEqualTo,
44  BeginsWith,
45  Contains,
46  IsNull,
47  IsNotNull,
48  DoesNotContain,
49  };
50 
51  QgsExtractByAttributeAlgorithm() = default;
52  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
53  QString name() const override;
54  QString displayName() const override;
55  QStringList tags() const override;
56  QString group() const override;
57  QString groupId() const override;
58  QString shortHelpString() const override;
59  QgsExtractByAttributeAlgorithm *createInstance() const override SIP_FACTORY;
60 
61  protected:
62 
63  QVariantMap processAlgorithm( const QVariantMap &parameters,
64  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
65 
66 };
67 
69 
70 #endif // QGSALGORITHMEXTRACTBYATTRIBUTE_H
71 
72 
Base class for providing feedback from a processing algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
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...
#define SIP_FACTORY
Definition: qgis_sip.h:69
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
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.