QGIS API Documentation 4.1.0-Master (5bf3c20f3c9)
Loading...
Searching...
No Matches
qgsalgorithmdissolve.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmdissolve.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 QGSALGORITHMDISSOLVE_H
19#define QGSALGORITHMDISSOLVE_H
20
21
22#include "qgis_sip.h"
23#include "qgsapplication.h"
25
26#include <QString>
27
28#define SIP_NO_FILE
29
30using namespace Qt::StringLiterals;
31
33
37class QgsCollectorAlgorithm : public QgsProcessingAlgorithm
38{
39 protected:
40 QVariantMap processCollection(
41 const QVariantMap &parameters,
42 QgsProcessingContext &context,
43 QgsProcessingFeedback *feedback,
44 const std::function<QgsGeometry( const QVector<QgsGeometry> & )> &collector,
45 int maxQueueLength = 0,
47 bool separateDisjoint = false
48 );
49};
50
54class QgsDissolveAlgorithm : public QgsCollectorAlgorithm
55{
56 public:
57 QgsDissolveAlgorithm() = default;
58 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
59 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmDissolve.svg"_s ); }
60 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmDissolve.svg"_s ); }
61 QString name() const override;
62 QString displayName() const override;
63 QStringList tags() const override;
64 QString group() const override;
65 QString groupId() const override;
66 QString shortHelpString() const override;
67 QString shortDescription() const override;
68 Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override;
69 QgsDissolveAlgorithm *createInstance() const override SIP_FACTORY;
70
71 protected:
72 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
73};
74
78class QgsCollectAlgorithm : public QgsCollectorAlgorithm
79{
80 public:
81 QgsCollectAlgorithm() = default;
82 QIcon icon() const override { return QgsApplication::getThemeIcon( u"/algorithms/mAlgorithmCollect.svg"_s ); }
83 QString svgIconPath() const override { return QgsApplication::iconPath( u"/algorithms/mAlgorithmCollect.svg"_s ); }
84 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
85 QString name() const override;
86 QString displayName() const override;
87 QStringList tags() const override;
88 QString group() const override;
89 QString groupId() const override;
90 QString shortHelpString() const override;
91 QString shortDescription() const override;
92 Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const override;
93 QgsCollectAlgorithm *createInstance() const override SIP_FACTORY;
94
95 protected:
96 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
97};
98
100
101#endif // QGSALGORITHMDISSOLVE_H
QFlags< ProcessingAlgorithmDocumentationFlag > ProcessingAlgorithmDocumentationFlags
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3745
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3839
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
A geometry is the spatial representation of a feature.
Abstract base class for processing algorithms.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
#define SIP_FACTORY
Definition qgis_sip.h:83