QGIS API Documentation 3.39.0-Master (67e056379ed)
Loading...
Searching...
No Matches
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"
26#include <functional>
27
29
33class 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 bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
43
44 protected:
45
46 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
47 QString outputName() const override;
48 QgsFields outputFields( const QgsFields &inputFields ) const override;
50
51 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
52 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) 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< Qgis::Statistic > mSelectedStats;
63 QString mPrefix;
64 QgsFields mNewFields;
65
66
67};
68
72class 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
90class 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
@ All
All statistics.
QFlags< Statistic > Statistics
Statistics to be calculated for generic values.
Definition qgis.h:5029
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3153
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
A geometry is the spatial representation of a feature.
Base class for all map layer types.
Definition qgsmaplayer.h:75
Point geometry type, with support for z-dimension and m-values.
Definition qgspoint.h:49
Abstract base class for processing algorithms.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)
Prepares the algorithm to run using the specified parameters.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
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...
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Processes an individual input feature from the source.
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 QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by the algorithm.
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
virtual Qgis::ProcessingFeatureSourceFlags sourceFlags() const
Returns the processing feature source flags to be used in the algorithm.
Base class for providing feedback from a processing algorithm.
QList< QgsFeature > QgsFeatureList