qgsalgorithmraiseexception.h

Go to the documentation of this file.

/***************************************************************************
                         qgsalgorithmraiseexception.h
                         ---------------------
    begin                : February 2020
    copyright            : (C) 2020 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 QGSALGORITHMRAISEEXCEPTION_H
#define QGSALGORITHMRAISEEXCEPTION_H
 
#define SIP_NO_FILE
 
#include "qgis_sip.h"
#include "qgsprocessingalgorithm.h"
#include "qgsapplication.h"
 
 
class QgsRaiseExceptionAlgorithm : public QgsProcessingAlgorithm
{
  public:
    QgsRaiseExceptionAlgorithm() = default;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
    Qgis::ProcessingAlgorithmFlags flags() const override;
    QString name() const override;
    QString displayName() const override;
    QStringList tags() const override;
    QString group() const override;
    QString groupId() const override;
    QString shortHelpString() const override;
    QString shortDescription() const override;
    QgsRaiseExceptionAlgorithm *createInstance() const override SIP_FACTORY;
 
  protected:
    QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
};
 
class QgsRaiseWarningAlgorithm : public QgsProcessingAlgorithm
{
  public:
    QgsRaiseWarningAlgorithm() = default;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
    Qgis::ProcessingAlgorithmFlags flags() const override;
    QString name() const override;
    QString displayName() const override;
    QStringList tags() const override;
    QString group() const override;
    QString groupId() const override;
    QString shortHelpString() const override;
    QString shortDescription() const override;
    QgsRaiseWarningAlgorithm *createInstance() const override SIP_FACTORY;
 
  protected:
    QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
};
 
class QgsRaiseMessageAlgorithm : public QgsProcessingAlgorithm
{
  public:
    QgsRaiseMessageAlgorithm() = default;
    void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
    Qgis::ProcessingAlgorithmFlags flags() const override;
    QString name() const override;
    QString displayName() const override;
    QStringList tags() const override;
    QString group() const override;
    QString groupId() const override;
    QString shortHelpString() const override;
    QString shortDescription() const override;
    QgsRaiseMessageAlgorithm *createInstance() const override SIP_FACTORY;
 
  protected:
    QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
};
 
 
#endif // QGSALGORITHMRAISEEXCEPTION_H