QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmsymmetricaldifference.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmsymmetricaldifference.h
3  ---------------------
4  Date : April 2018
5  Copyright : (C) 2018 by Martin Dobias
6  Email : wonder dot sk at gmail dot com
7  ***************************************************************************
8  * *
9  * This program is free software; you can redistribute it and/or modify *
10  * it under the terms of the GNU General Public License as published by *
11  * the Free Software Foundation; either version 2 of the License, or *
12  * (at your option) any later version. *
13  * *
14  ***************************************************************************/
15 
16 #ifndef QGSALGORITHMSYMMETRICALDIFFERENCE_H
17 #define QGSALGORITHMSYMMETRICALDIFFERENCE_H
18 
19 #define SIP_NO_FILE
20 
21 #include "qgsprocessingalgorithm.h"
22 #include "qgsapplication.h"
23 
25 
26 class QgsSymmetricalDifferenceAlgorithm : public QgsProcessingAlgorithm
27 {
28  public:
29  QgsSymmetricalDifferenceAlgorithm() = default;
30  QIcon icon() const override { return QgsApplication::getThemeIcon( QStringLiteral( "/algorithms/mAlgorithmSymmetricalDifference.svg" ) ); }
31  QString svgIconPath() const override { return QgsApplication::iconPath( QStringLiteral( "/algorithms/mAlgorithmSymmetricalDifference.svg" ) ); }
32  QString name() const override;
33  QString displayName() const override;
34  QString group() const override;
35  QString groupId() const override;
36  QString shortHelpString() const override;
37 
38  protected:
39  QgsProcessingAlgorithm *createInstance() const override;
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
42 
43 };
44 
46 
47 #endif // QGSALGORITHMSYMMETRICALDIFFERENCE_H
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.
static QIcon getThemeIcon(const QString &name)
Helper to get a theme icon.
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 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 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's icon.