QGIS API Documentation  3.26.3-Buenos Aires (65e4edfdad)
qgsalgorithmexporttospreadsheet.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmexporttospreadsheet.h
3  ------------------
4  begin : December 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 QGSALGORITHMEXPORTTOSPREADSHEET_H
19 #define QGSALGORITHMEXPORTTOSPREADSHEET_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 #include "qgsvectorfilewriter.h"
26 
28 
29 class QgsVectorLayer;
30 
34 class QgsExportToSpreadsheetAlgorithm : public QgsProcessingAlgorithm
35 {
36 
37  public:
38 
39  QgsExportToSpreadsheetAlgorithm() = default;
40  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
41  QString name() const override;
42  QString displayName() const override;
43  QStringList tags() const override;
44  QString group() const override;
45  QString groupId() const override;
46  QString shortHelpString() const override;
47  QgsExportToSpreadsheetAlgorithm *createInstance() const override SIP_FACTORY;
48 
49  protected:
50 
51  bool prepareAlgorithm( const QVariantMap &parameters,
52  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53  QVariantMap processAlgorithm( const QVariantMap &parameters,
54  QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
55 
56  private:
57 
58  bool exportVectorLayer( QgsVectorLayer *layer, const QString &path, QgsProcessingContext &context,
59  QgsProcessingFeedback *feedback, const QString &driverName, bool createNew, bool preferAlias,
60  QgsVectorFileWriter::FieldValueConverter *converter );
61 
62  std::vector< std::unique_ptr< QgsMapLayer> > mLayers;
63 
64 };
65 
67 
68 #endif // QGSALGORITHMEXPORTTOSPREADSHEET_H
69 
70 
QgsVectorFileWriter
A convenience class for writing vector layers to disk based formats (e.g. Shapefiles,...
Definition: qgsvectorfilewriter.h:47
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
geos::unique_ptr
std::unique_ptr< GEOSGeometry, GeosDeleter > unique_ptr
Scoped GEOS pointer.
Definition: qgsgeos.h:79
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition: qgsprocessingcontext.h:46
qgsprocessingalgorithm.h
qgis_sip.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
QgsVectorLayer
Represents a vector layer which manages a vector based data sets.
Definition: qgsvectorlayer.h:391
QgsMapLayer
Base class for all map layer types. This is the base class for all map layer types (vector,...
Definition: qgsmaplayer.h:72
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition: qgsprocessingalgorithm.h:225
qgsvectorfilewriter.h
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.