qgsprocessingregistry.h

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingregistry.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 QGSPROCESSINGREGISTRY_H
#define QGSPROCESSINGREGISTRY_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgsprocessingprovider.h"
 
#include <QMap>
 
class QgsProcessingParameterType;
class QgsProcessingAlgorithmConfigurationWidgetFactory;

class CORE_EXPORT QgsProcessingAlgorithmInformation
{
  public:
    QString displayName;

    QIcon icon;
};
 

class CORE_EXPORT QgsProcessingRegistry : public QObject
{
    Q_OBJECT
 
  public:
    QgsProcessingRegistry( QObject *parent SIP_TRANSFERTHIS = nullptr );
 
    ~QgsProcessingRegistry() override;
 
    QgsProcessingRegistry( const QgsProcessingRegistry &other ) = delete;
    QgsProcessingRegistry &operator=( const QgsProcessingRegistry &other ) = delete;

    QList<QgsProcessingProvider *> providers() const { return mProviders.values(); }

    bool addProvider( QgsProcessingProvider *provider SIP_TRANSFER );

    bool removeProvider( QgsProcessingProvider *provider );

    bool removeProvider( const QString &providerId );
 
    // clang-format off
    QgsProcessingProvider *providerById( const QString &id ) const SIP_HOLDGIL;
    // clang-format on

    QList< const QgsProcessingAlgorithm *> algorithms() const;

    QgsProcessingAlgorithmInformation algorithmInformation( const QString &id ) const;

    const QgsProcessingAlgorithm *algorithmById( const QString &id ) const;
 
    /*
     * IMPORTANT: While it seems like /Factory/ would be the correct annotation here, that's not
     * the case.
     * As per Phil Thomson's advice on https://www.riverbankcomputing.com/pipermail/pyqt/2017-July/039450.html:
     *
     * "
     * /Factory/ is used when the instance returned is guaranteed to be new to Python.
     * In this case it isn't because it has already been seen when being returned by QgsProcessingAlgorithm::createInstance()
     * (However for a different sub-class implemented in C++ then it would be the first time it was seen
     * by Python so the /Factory/ on create() would be correct.)
     *
     * You might try using /TransferBack/ on create() instead - that might be the best compromise.
     * "
     */

    QgsProcessingAlgorithm *createAlgorithmById( const QString &id, const QVariantMap &configuration = QVariantMap() ) const SIP_TRANSFERBACK;

    void addAlgorithmAlias( const QString &aliasId, const QString &actualId );

    bool addParameterType( QgsProcessingParameterType *type SIP_TRANSFER );

    void removeParameterType( QgsProcessingParameterType *type );

    QgsProcessingParameterType *parameterType( const QString &id ) const;

    QList<QgsProcessingParameterType *> parameterTypes() const;
 
  signals:

    void providerAdded( const QString &id );

    void providerRemoved( const QString &id );

    void parameterTypeAdded( QgsProcessingParameterType *type );

    void parameterTypeRemoved( QgsProcessingParameterType *type );
 
  private:

    QMap<QString, QgsProcessingProvider *> mProviders;

    QMap<QString, QgsProcessingParameterType *> mParameterTypes;
 
    QMap< QString, QString > mAlgorithmAliases;
 
    mutable QMap< QString, QgsProcessingAlgorithmInformation > mCachedInformation;
 
#ifdef SIP_RUN
    QgsProcessingRegistry( const QgsProcessingRegistry &other );
#endif
 
    friend class TestQgsProcessing;
};
 
#endif // QGSPROCESSINGREGISTRY_H