QGIS API Documentation  3.0.2-Girona (307d082)
qgsprocessingprovider.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsprocessingprovider.h
3  ------------------------
4  begin : December 2016
5  copyright : (C) 2016 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 QGSPROCESSINGPROVIDER_H
19 #define QGSPROCESSINGPROVIDER_H
20 
21 #include "qgis_core.h"
22 #include "qgis.h"
23 #include "qgsprocessingalgorithm.h"
24 #include <QIcon>
25 
34 class CORE_EXPORT QgsProcessingProvider : public QObject
35 {
36  Q_OBJECT
37 
38  public:
39 
43  QgsProcessingProvider( QObject *parent SIP_TRANSFERTHIS = nullptr );
44 
45  ~QgsProcessingProvider() override;
46 
48  QgsProcessingProvider( const QgsProcessingProvider &other ) = delete;
50  QgsProcessingProvider &operator=( const QgsProcessingProvider &other ) = delete;
51 
56  virtual QIcon icon() const;
57 
62  virtual QString svgIconPath() const;
63 
71  virtual QString id() const = 0;
72 
79  virtual QString helpId() const;
80 
87  virtual QString name() const = 0;
88 
99  virtual QString longName() const;
100 
106  virtual bool canBeActivated() const { return true; }
107 
111  virtual bool isActive() const { return true; }
112 
117  virtual QStringList supportedOutputRasterLayerExtensions() const;
118 
125  virtual QStringList supportedOutputVectorLayerExtensions() const;
126 
141  virtual QString defaultVectorFileExtension( bool hasGeometry = true ) const;
142 
154  virtual QString defaultRasterFileExtension() const;
155 
169  virtual bool supportsNonFileBasedOutput() const;
170 
180  virtual bool load() { refreshAlgorithms(); return true; }
181 
186  virtual void unload() {}
187 
191  void refreshAlgorithms();
192 
197  QList< const QgsProcessingAlgorithm * > algorithms() const;
198 
204  const QgsProcessingAlgorithm *algorithm( const QString &name ) const;
205 
206  signals:
207 
213  void algorithmsLoaded();
214 
215  protected:
216 
221  virtual void loadAlgorithms() = 0;
222 
226  bool addAlgorithm( QgsProcessingAlgorithm *algorithm SIP_TRANSFER );
227 
228  private:
229 
230  QMap< QString, const QgsProcessingAlgorithm * > mAlgorithms;
231 
232 #ifdef SIP_RUN
234 #endif
235 };
236 
237 #endif // QGSPROCESSINGPROVIDER_H
238 
239 
#define SIP_TRANSFERTHIS
Definition: qgis_sip.h:46
Abstract base class for processing providers.
Abstract base class for processing algorithms.
virtual bool isActive() const
Returns true if the provider is active and able to run algorithms.
#define SIP_TRANSFER
Definition: qgis_sip.h:36
virtual bool load()
Loads the provider.
virtual bool canBeActivated() const
Returns true if the provider can be activated, or false if it cannot be activated (e...
virtual void unload()
Unloads the provider.