QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmextractzmvalues.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmextractzmvalues.h
3  ---------------------------------
4  begin : January 2019
5  copyright : (C) 2019 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 QGSALGORITHMEXTRACTZMVALUES_H
19 #define QGSALGORITHMEXTRACTZMVALUES_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 #include "qgsstatisticalsummary.h"
26 #include <functional>
27 
29 
33 class QgsExtractZMValuesAlgorithmBase : public QgsProcessingFeatureBasedAlgorithm
34 {
35 
36  public:
37 
38  QgsExtractZMValuesAlgorithmBase() = default;
39  QString group() const override;
40  QString groupId() const override;
41  QList<int> inputLayerTypes() const override;
42 
43  protected:
44 
45  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
46  QString outputName() const override;
47  QgsFields outputFields( const QgsFields &inputFields ) const override;
49 
50  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
51  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
52  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
53 
54  protected:
55 
56  std::function<double( const QgsPoint & )> mExtractValFunc;
57  std::function<bool( const QgsGeometry & )> mTestGeomFunc;
58  QString mDefaultFieldPrefix;
59  private:
60 
61  QList< QgsStatisticalSummary::Statistic > mSelectedStats;
62  QgsStatisticalSummary::Statistics mStats = QgsStatisticalSummary::All;
63  QString mPrefix;
64  QgsFields mNewFields;
65 
66 
67 };
68 
72 class QgsExtractZValuesAlgorithm : public QgsExtractZMValuesAlgorithmBase
73 {
74  public:
75  QgsExtractZValuesAlgorithm();
76 
77  QString name() const override;
78  QString displayName() const override;
79  QgsProcessingAlgorithm *createInstance() const override;
80  QStringList tags() const override;
81  QString shortHelpString() const override;
82  QString shortDescription() const override;
83 
84 };
85 
86 
90 class QgsExtractMValuesAlgorithm : public QgsExtractZMValuesAlgorithmBase
91 {
92  public:
93  QgsExtractMValuesAlgorithm();
94 
95  QString name() const override;
96  QString displayName() const override;
97  QgsProcessingAlgorithm *createInstance() const override;
98  QStringList tags() const override;
99  QString shortHelpString() const override;
100  QString shortDescription() const override;
101 
102 };
103 
105 
106 #endif // QGSALGORITHMEXTRACTZMVALUES_H
107 
108 
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
virtual QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by the algorithm...
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Base class for all map layer types.
Definition: qgsmaplayer.h:83
Base class for providing feedback from a processing algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:583
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Container of fields for a vector layer.
Definition: qgsfields.h:44
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
Abstract base class for processing algorithms.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
virtual QgsProcessingFeatureSource::Flag sourceFlags() const
Returns the processing feature source flags to be used in the algorithm.
bool supportInPlaceEdit(const QgsMapLayer *layer) const override
Checks whether this algorithm supports in-place editing on the given layer Default implementation for...
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Contains information about the context in which a processing algorithm is executed.