QGIS API Documentation 3.38.0-Grenoble (exported)
Loading...
Searching...
No Matches
qgsalgorithmkeepnbiggestparts.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmkeepnbiggestparts.h
3 ---------------------
4 begin : July 2023
5 copyright : (C) 2023 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 QGSALGORITHMKEEPNBIGGESTPARTS_H
19#define QGSALGORITHMKEEPNBIGGESTPARTS_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25
27
31class QgsKeepNBiggestPartsAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32{
33
34 public:
35
36 QgsKeepNBiggestPartsAlgorithm() = default;
37 QString name() const override;
38 QString displayName() const override;
39 QStringList tags() const override;
40 QString group() const override;
41 QString groupId() const override;
42 QString shortHelpString() const override;
43 QgsKeepNBiggestPartsAlgorithm *createInstance() const override SIP_FACTORY;
44 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
45
46 protected:
47 QString inputParameterName() const override;
48 QString outputName() const override;
49 QList<int> inputLayerTypes() const override;
50 Qgis::ProcessingSourceType outputLayerType() const override;
51 Qgis::ProcessingFeatureSourceFlags sourceFlags() const override;
52 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54
55 private:
56
57 int mPartsToKeep = 1;
58 bool mDynamicPartsToKeep = false;
59 QgsProperty mPartsToKeepProperty;
60
61};
62
63
65
66#endif // QGSALGORITHMKEEPNBIGGESTPARTS_H
67
68
ProcessingSourceType
Processing data source types.
Definition qgis.h:2995
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3148
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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 displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
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...
Base class for providing feedback from a processing algorithm.
A store for object properties.
#define SIP_FACTORY
Definition qgis_sip.h:76
QList< QgsFeature > QgsFeatureList