QGIS API Documentation
3.16.0-Hannover (43b64b13f3)
src
analysis
processing
qgsalgorithmfilter.h
Go to the documentation of this file.
1
/***************************************************************************
2
qgsalgorithmfilter.h
3
---------------------
4
begin : April 2018
5
copyright : (C) 2018 by Matthias Kuhn
6
email :
[email protected]
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 QGSFILTERALGORITHM_H
19
#define QGSFILTERALGORITHM_H
20
21
#define SIP_NO_FILE
22
23
#include "
qgis_sip.h
"
24
#include "
qgsprocessingalgorithm.h
"
25
26
class
QgsProcessingModelAlgorithm;
27
class
QTableWidget;
28
30
38
class
QgsFilterAlgorithm :
public
QgsProcessingAlgorithm
39
{
40
public
:
41
QgsFilterAlgorithm() =
default
;
42
~QgsFilterAlgorithm()
override
;
43
44
void
initAlgorithm
(
const
QVariantMap &configuration = QVariantMap() )
override
;
45
QString
name
()
const override
;
46
QString
displayName
()
const override
;
47
QStringList
tags
()
const override
;
48
QString
group
()
const override
;
49
QString
groupId
()
const override
;
50
Flags
flags
()
const override
;
51
QString
shortHelpString
()
const override
;
52
QgsFilterAlgorithm *
createInstance
() const override
SIP_FACTORY
;
53
54
protected:
55
56
QVariantMap processAlgorithm( const QVariantMap ¶meters,
57
QgsProcessingContext
&context,
QgsProcessingFeedback
*feedback ) override;
58
59
private:
60
struct Output
61
{
62
Output(
const
QString &name,
const
QString &expression )
63
: name( name )
64
, expression( expression )
65
{}
66
QString
name
;
67
QgsExpression
expression;
68
std::unique_ptr< QgsFeatureSink > sink;
69
QString destinationIdentifier;
70
};
71
72
QList<Output *> mOutputs;
73
};
74
76
77
#endif // QGSFILTERALGORITHM_H
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition:
qgsprocessingfeedback.h:38
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition:
qgsprocessingalgorithm.h:233
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
SIP_FACTORY
#define SIP_FACTORY
Definition:
qgis_sip.h:76
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition:
qgsprocessingcontext.h:44
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition:
qgsprocessingalgorithm.cpp:63
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition:
qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition:
qgsprocessingalgorithm.h:224
QgsProcessingAlgorithm::flags
virtual Flags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Definition:
qgsprocessingalgorithm.cpp:88
QgsExpression
Class for parsing and evaluation of expressions (formerly called "search strings").
Definition:
qgsexpression.h:105
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition:
qgsprocessingalgorithm.h:180
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
Generated on Sat Oct 24 2020 17:43:09 for QGIS API Documentation by
1.8.20