QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsalgorithmdxfexport.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmdxfexport.h
3  ---------------------
4  Date : September 2020
5  Copyright : (C) 2020 by Alexander Bruy
6  Email : alexander dot bruy 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 QGSDXFEXPORTALGORITHM_H
17 #define QGSDXFEXPORTALGORITHM_H
18 
19 #define SIP_NO_FILE
20 
21 #include "qgsprocessingalgorithm.h"
22 
24 
25 class QgsDxfExportAlgorithm : public QgsProcessingAlgorithm
26 {
27  public:
28  QgsDxfExportAlgorithm() = default;
29  QString name() const override;
30  QString displayName() const override;
31  QStringList tags() const override;
32  QString group() const override;
33  QString groupId() const override;
34  QString shortHelpString() const override;
35  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
36  QgsDxfExportAlgorithm *createInstance() const override SIP_FACTORY;
37 
38  protected:
39  QVariantMap processAlgorithm( const QVariantMap &parameters,
40  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
41 };
42 
44 
45 #endif // QGSDXFEXPORTALGORITHM_H
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
Base class for providing feedback from a processing algorithm.
Definition: qgsprocessingfeedback.h:37
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:234
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
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
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
qgsprocessingalgorithm.h
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition: qgsprocessingalgorithm.cpp:65
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition: qgsprocessingalgorithm.h:52
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:225
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:181
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.