QGIS API Documentation  3.17.0-Master (ca637cfeb2)
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmdensifygeometries.h
3  ---------------------
4  begin : January 2019
5  copyright : (C) 2019 by Matthias Kuhn
6  email : [email protected]
7  ***************************************************************************/
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  ***************************************************************************/
21 #define SIP_NO_FILE
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
29 class QgsDensifyGeometriesByIntervalAlgorithm : public QgsProcessingFeatureBasedAlgorithm
30 {
31  public:
33  QgsDensifyGeometriesByIntervalAlgorithm() = default;
34  QString name() const override;
35  QString displayName() const override;
36  QStringList tags() const override;
37  QString group() const override;
38  QString groupId() const override;
39  QString shortHelpString() const override;
40  QString shortDescription() const override;
41  QgsDensifyGeometriesByIntervalAlgorithm *createInstance() const override SIP_FACTORY;
42  QList<int> inputLayerTypes() const override;
44  protected:
45  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
46  QString outputName() const override;
47  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
48  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
50  private:
51  double mInterval = 0.0;
52  bool mDynamicInterval = false;
53  QgsProperty mIntervalProperty;
54 };
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this 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 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 name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
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.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgis_sip.h:76
A store for object properties.
Definition: qgsproperty.h:231
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
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.