QGIS API Documentation  3.14.0-Pi (9f7028fd23)
qgsalgorithmraiseexception.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmraiseexception.h
3  ---------------------
4  begin : February 2020
5  copyright : (C) 2020 by Nyall Dawson
6  email : nyall dot dawson 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 QGSALGORITHMRAISEEXCEPTION_H
19 #define QGSALGORITHMRAISEEXCEPTION_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 QgsRaiseExceptionAlgorithm : public QgsProcessingAlgorithm
33 {
34  public:
35  QgsRaiseExceptionAlgorithm() = default;
36  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
37  Flags flags() const override;
38  QString name() const override;
39  QString displayName() const override;
40  QStringList tags() const override;
41  QString group() const override;
42  QString groupId() const override;
43  QString shortHelpString() const override;
44  QString shortDescription() const override;
45  QgsRaiseExceptionAlgorithm *createInstance() const override SIP_FACTORY;
46 
47  protected:
48 
49  QVariantMap processAlgorithm( const QVariantMap &parameters,
50  QgsProcessingContext &context, QgsProcessingFeedback * ) override;
51 
52 };
53 
57 class QgsRaiseWarningAlgorithm : public QgsProcessingAlgorithm
58 {
59  public:
60  QgsRaiseWarningAlgorithm() = default;
61  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
62  Flags flags() const override;
63  QString name() const override;
64  QString displayName() const override;
65  QStringList tags() const override;
66  QString group() const override;
67  QString groupId() const override;
68  QString shortHelpString() const override;
69  QString shortDescription() const override;
70  QgsRaiseWarningAlgorithm *createInstance() const override SIP_FACTORY;
71 
72  protected:
73 
74  QVariantMap processAlgorithm( const QVariantMap &parameters,
75  QgsProcessingContext &context, QgsProcessingFeedback * ) override;
76 
77 };
78 
79 
81 
82 #endif // QGSALGORITHMRAISEEXCEPTION_H
QgsProcessingAlgorithm::shortDescription
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
Definition: qgsprocessingalgorithm.cpp:58
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingFeedback
Definition: qgsprocessingfeedback.h:37
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:231
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
qgsapplication.h
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingAlgorithm::processAlgorithm
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
QgsProcessingContext
Definition: qgsprocessingcontext.h:43
qgsprocessingalgorithm.h
qgis_sip.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:63
QgsProcessingAlgorithm
Definition: qgsprocessingalgorithm.h:51
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:222
QgsProcessingAlgorithm::flags
virtual Flags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
Definition: qgsprocessingalgorithm.cpp:88
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition: qgsprocessingalgorithm.h:178
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.