QGIS API Documentation  3.17.0-Master (ca637cfeb2)
qgsalgorithmexplodehstore.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmexplodehstore.h
3  ---------------------
4  begin : September 2018
5  copyright : (C) 2018 by Etienne Trimaille
6  email : etienne dot trimaille 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 QGSALGORITHMEXPLODEHSTORE_H
19 #define QGSALGORITHMEXPLODEHSTORE_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsExplodeHstoreAlgorithm : public QgsProcessingAlgorithm
32 {
33 
34  public:
35  QgsExplodeHstoreAlgorithm() = default;
36  QString name() const override;
37  QString displayName() const override;
38  QString group() const override;
39  QString groupId() const override;
40  QStringList tags() const override;
41  QString shortHelpString() const override;
42 
43  protected:
44  QgsProcessingAlgorithm *createInstance() const override;
45  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
46  QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
47 
48 };
49 
51 
52 #endif // QGSALGORITHMEXPLODEHSTORE_H
53 
54 
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.
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 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.