QGIS API Documentation  3.0.2-Girona (307d082)
qgsalgorithmfiledownloader.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmfiledownloader.h
3  ---------------------
4  begin : October 2017
5  copyright : (C) 2017 by Etienne Trimaille
6  email : etienne at kartoza 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 QGSALGORITHMFILEDOWNLOADER_H
19 #define QGSALGORITHMFILEDOWNLOADER_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
29 
33 class QgsFileDownloaderAlgorithm : public QObject, public QgsProcessingAlgorithm
34 {
35  Q_OBJECT
36 
37  public:
38  QgsFileDownloaderAlgorithm() = default;
39  void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
40  QString name() const override;
41  QString displayName() const override;
42  QStringList tags() const override;
43  QString group() const override;
44  QString groupId() const override;
45  QString shortHelpString() const override;
46  QgsFileDownloaderAlgorithm *createInstance() const override SIP_FACTORY;
47 
48  protected:
49 
50  QVariantMap processAlgorithm( const QVariantMap &parameters,
51  QgsProcessingContext &context, QgsProcessingFeedback * ) override;
52 
53  private:
54  QString mTotal;
55  QString mReceived;
56  QgsProcessingFeedback *mFeedback = nullptr;
57  QString mLastReport;
58  void reportErrors( const QStringList &errors );
59  void receiveProgressFromDownloader( qint64 bytesReceived, qint64 bytesTotal );
60  void sendProgressFeedback();
61 };
62 
64 
65 #endif // QGSALGORITHMFILEDOWNLOADER_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:69
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
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.