QGIS API Documentation  3.17.0-Master (ca637cfeb2)
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmbuffer.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_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 #include "qgsapplication.h"
32 class QgsBufferAlgorithm : public QgsProcessingAlgorithm
33 {
35  public:
37  QgsBufferAlgorithm() = default;
38  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
39  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmBuffer.svg" ) ); }
40  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmBuffer.svg" ) ); }
41  QString name() const override;
42  QString displayName() const override;
43  QStringList tags() const override;
44  QString group() const override;
45  QString groupId() const override;
46  QString shortHelpString() const override;
47  QgsBufferAlgorithm *createInstance() const override SIP_FACTORY;
48  bool supportInPlaceEdit( const QgsMapLayer *layer ) const override;
49  QgsProcessingAlgorithm::Flags flags() const override;
52  const QVariantMap &parameters,
53  QgsProcessingContext &context,
54  const QMap< QString, QgsProcessingAlgorithm::VectorProperties > &sourceProperties ) const override;
56  protected:
58  QVariantMap processAlgorithm( const QVariantMap &parameters,
59  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
62 };
Base class for all map layer types.
Definition: qgsmaplayer.h:83
Properties of a vector source or sink used in an algorithm.
virtual QIcon icon() const
Returns an icon for the algorithm.
Base class for providing feedback from a processing algorithm.
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.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
virtual Flags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users...
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
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 shortHelpString() const
Returns a localised short helper string for the algorithm.
Abstract base class for processing algorithms.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual bool supportInPlaceEdit(const QgsMapLayer *layer) const
Checks whether this algorithm supports in-place editing on the given layer Default implementation ret...
Definition: qgis_sip.h:76
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QgsProcessingAlgorithm::VectorProperties sinkProperties(const QString &sink, const QVariantMap &parameters, QgsProcessingContext &context, const QMap< QString, QgsProcessingAlgorithm::VectorProperties > &sourceProperties) const
Returns the vector properties which will be used for the sink with matching name. ...
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.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm&#39;s icon.