QGIS API Documentation  3.17.0-Master (ca637cfeb2)
qgsalgorithmpointslayerfromtable.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmpointslayerfromtable.h
3  ------------------
4  begin : November 2019
5  copyright : (C) 2019 by Alexander Bruy
6  email : alexander dot bruy 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 QGSALGORITHMPOINTSLAYERFROMTABLE_H
19 #define QGSALGORITHMPOINTSLAYERFROMTABLE_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 #include "qgsapplication.h"
26 
28 
32 class QgsPointsLayerFromTableAlgorithm : public QgsProcessingAlgorithm
33 {
34 
35  public:
36 
37  QgsPointsLayerFromTableAlgorithm() = default;
38  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
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  QgsPointsLayerFromTableAlgorithm *createInstance() const override SIP_FACTORY;
46 
47  protected:
48 
49  QVariantMap processAlgorithm( const QVariantMap &parameters,
50  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
51 };
52 
54 
55 #endif // QGSALGORITHMPOINTSLAYERFROMTABLE_H
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.
#define SIP_FACTORY
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 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.