QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
qgsalgorithmsetmvalue.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmsetmvalue.h
3 ---------------------
4 begin : November 2019
5 copyright : (C) 2019 by Alexander Bruy
6 email : alexander dot bruy 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 QGSALGORITHMSETMVALUE_H
19#define QGSALGORITHMSETMVALUE_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25
27
31class QgsSetMValueAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32{
33
34 public:
35
36 QgsSetMValueAlgorithm() = 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 QgsSetMValueAlgorithm *createInstance() const override SIP_FACTORY;
44
45 protected:
46
47 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
48 QString outputName() const override;
49 Qgis::WkbType outputWkbType( Qgis::WkbType inputWkbType ) const override;
50 Qgis::ProcessingFeatureSourceFlags sourceFlags() const override;
51 bool supportInPlaceEdit( const QgsMapLayer *l ) const override;
52
53 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
54 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55
56 private:
57
58 double mMValue = 0.0;
59 bool mDynamicMValue = false;
60 QgsProperty mMValueProperty;
61};
62
64
65#endif // QGSALGORITHMSETMVALUE_H
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition: qgis.h:182
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition: qgis.h:3011
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition: qgsfeature.h:56
Base class for all map layer types.
Definition: qgsmaplayer.h:75
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.
Definition: qgsproperty.h:228
#define SIP_FACTORY
Definition: qgis_sip.h:76
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:917