QGIS API Documentation  3.4.15-Madeira (e83d02e274)
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmcentroid.h
3  ----------------------
4  begin : April 2017
5  copyright : (C) 2017 by Nyall Dawson
6  email : nyall dot dawson at gmail dot com
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.h"
24 #include "qgsprocessingalgorithm.h"
31 class QgsCentroidAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
34  public:
36  QgsCentroidAlgorithm() = default;
37  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmCentroids.svg" ) ); }
38  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmCentroids.svg" ) ); }
39  QString name() const override;
40  QString displayName() const override;
41  QStringList tags() const override;
42  QString group() const override;
43  QString groupId() const override;
44  QString shortHelpString() const override;
45  QgsCentroidAlgorithm *createInstance() const override SIP_FACTORY;
46  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
48  protected:
50  QString outputName() const override;
52  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) const override { Q_UNUSED( inputWkbType ); return QgsWkbTypes::Point; }
54  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
57  private:
59  bool mAllParts = false;
60  bool mDynamicAllParts = false;
61  QgsProperty mAllPartsProperty;
62 };
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:571
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
virtual QgsProcessing::SourceType outputLayerType() const
Returns the layer type for layers generated by this algorithm, if this is possible to determine in ad...
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QgsWkbTypes::Type outputWkbType(QgsWkbTypes::Type inputWkbType) const
Maps the input WKB geometry type (inputWkbType) to the corresponding output WKB type generated by the...
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 WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:68
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm&#39;s icon.
Definition: qgis_sip.h:69
A store for object properties.
Definition: qgsproperty.h:229
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Vector point layers.
Definition: qgsprocessing.h:48
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Data source types enum.
Definition: qgsprocessing.h:44
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
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.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QIcon icon() const
Returns an icon for the algorithm.