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.h"
#include "qgis_core.h"
#include "qgsprocessingalgorithm.h"
 
#include <QIcon>
 
#ifdef SIP_RUN
// clang-format off
% ModuleHeaderCode
#include <qgsprocessingmodelprovider.h>
#include <qgsprocessingprojectmodelprovider.h>
    % End
// clang-format on
#endif

  class CORE_EXPORT QgsProcessingProvider : public QObject
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( qobject_cast<QgsProcessingProjectModelProvider *>( sipCpp ) )
      sipType = sipType_QgsProcessingProjectModelProvider;
    else if ( qobject_cast<QgsProcessingModelProvider *>( sipCpp ) )
      sipType = sipType_QgsProcessingModelProvider;
    else
      sipType = nullptr;
    SIP_END
#endif
 
    Q_OBJECT
 
  public:
    QgsProcessingProvider( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsProcessingProvider() override;
 
    QgsProcessingProvider( const QgsProcessingProvider &other ) = delete;
    QgsProcessingProvider &operator=( const QgsProcessingProvider &other ) = delete;
 
    // clang-format off
    virtual QIcon icon() const SIP_HOLDGIL;
    // clang-format on

    virtual QString svgIconPath() const SIP_HOLDGIL;

    virtual Qgis::ProcessingProviderFlags flags() const SIP_HOLDGIL;

    virtual QString id() const = 0 SIP_HOLDGIL;

    virtual QString helpId() const SIP_HOLDGIL;

    virtual QString name() const = 0 SIP_HOLDGIL;

    virtual QString longName() const SIP_HOLDGIL;

    virtual QString versionInfo() const SIP_HOLDGIL;

    virtual bool canBeActivated() const { return true; }

    virtual QString warningMessage() const { return QString(); }

    virtual bool isActive() const { return true; }

    QStringList supportedOutputRasterLayerExtensions() const;

    virtual QList<QPair<QString, QString>> supportedOutputRasterLayerFormatAndExtensions() const;

    static QList<QPair<QString, QString>> supportedOutputRasterLayerFormatAndExtensionsDefault() SIP_SKIP;

    virtual QStringList supportedOutputVectorLayerExtensions() const;

    virtual QStringList supportedOutputPointCloudLayerExtensions() const;

    virtual QStringList supportedOutputVectorTileLayerExtensions() 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 defaultRasterFileFormat() const;

    QString defaultRasterFileExtension() const;

    virtual QString defaultPointCloudFileExtension() const;

    virtual QString defaultVectorTileFileExtension() 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
};
 
#endif // QGSPROCESSINGPROVIDER_H