qgsprocessingprovider.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingprovider.h
                         ------------------------
    begin                : December 2016
    copyright            : (C) 2016 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSPROCESSINGPROVIDER_H
#define QGSPROCESSINGPROVIDER_H
 
#include "qgis_core.h"
#include "qgis.h"
#include "qgsprocessingalgorithm.h"
#include <QIcon>
 
class CORE_EXPORT QgsProcessingProvider : public QObject
{
    Q_OBJECT
 
  public:
 
    enum Flag
    {
      FlagDeemphasiseSearchResults = 1 << 1, 
    };
    Q_DECLARE_FLAGS( Flags, Flag )
 
    
    QgsProcessingProvider( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsProcessingProvider() override;
 
    QgsProcessingProvider( const QgsProcessingProvider &other ) = delete;
    QgsProcessingProvider &operator=( const QgsProcessingProvider &other ) = delete;
 
    virtual QIcon icon() const;
 
    virtual QString svgIconPath() const;
 
    virtual Flags flags() const;
 
    virtual QString id() const = 0;
 
    virtual QString helpId() const;
 
    virtual QString name() const = 0;
 
    virtual QString longName() const;
 
    virtual QString versionInfo() const;
 
    virtual bool canBeActivated() const { return true; }
 
    virtual QString warningMessage() const { return QString(); }
 
    virtual bool isActive() const { return true; }
 
    virtual QStringList supportedOutputRasterLayerExtensions() const;
 
    virtual QStringList supportedOutputVectorLayerExtensions() const;
 
    virtual QStringList supportedOutputTableExtensions() const;
 
    virtual bool isSupportedOutputValue( const QVariant &outputValue, const QgsProcessingDestinationParameter *parameter, QgsProcessingContext &context, QString &error SIP_OUT ) const;
 
    virtual QString defaultVectorFileExtension( bool hasGeometry = true ) const;
 
    virtual QString defaultRasterFileExtension() const;
 
    virtual bool supportsNonFileBasedOutput() const;
 
    virtual bool load() { refreshAlgorithms(); return true; }
 
    virtual void unload() {}
 
    void refreshAlgorithms();
 
    QList< const QgsProcessingAlgorithm * > algorithms() const;
 
    const QgsProcessingAlgorithm *algorithm( const QString &name ) const;
 
  signals:
 
    void algorithmsLoaded();
 
  protected:
 
    virtual void loadAlgorithms() = 0;
 
    bool addAlgorithm( QgsProcessingAlgorithm *algorithm SIP_TRANSFER );
 
  private:
 
    QMap< QString, const QgsProcessingAlgorithm * > mAlgorithms;
 
#ifdef SIP_RUN
    QgsProcessingProvider( const QgsProcessingProvider &other );
#endif
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QgsProcessingProvider::Flags )
 
#endif // QGSPROCESSINGPROVIDER_H