QGIS API Documentation 4.3.0-Master (45633be667c)
Loading...
Searching...
No Matches
qgsalgorithmflowdirection.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmflowdirection.h
3 ---------------------
4 begin : September 2026
5 copyright : (C) 2026 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 QGSALGORITHMFLOWDIRECTION_H
19#define QGSALGORITHMFLOWDIRECTION_H
20
21
22#include "qgis_sip.h"
24
25#define SIP_NO_FILE
26
28
32class QgsFlowDirectionD8Algorithm : public QgsProcessingAlgorithm
33{
34 public:
35 QgsFlowDirectionD8Algorithm() = default;
36
37 QString name() const override;
38 QString displayName() const override;
39 QString shortDescription() const override;
40 QString shortHelpString() const override;
41 QList<QgsAcademicReference> academicReferences() const override;
42 QList<QgsProcessingAlgorithm::ExternalLink> externalLinks() const override;
43 QString group() const override;
44 QString groupId() const override;
45 QStringList tags() const override;
46 QgsProcessingAlgorithm *createInstance() const override;
47
48 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
49
50 protected:
51 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
52 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53
54 private:
55 std::unique_ptr<QgsRasterInterface> mInterface;
56 int mLayerWidth = 0;
57 int mLayerHeight = 0;
58 double mCellSizeX = 0.0;
59 double mCellSizeY = 0.0;
60 QgsRectangle mExtent;
62};
64
65#endif // QGSALGORITHMFLOWDIRECTION_H
Represents a coordinate reference system (CRS).
Abstract base class for processing algorithms.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
virtual bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)
Prepares the algorithm to run using the specified parameters.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QVariantMap processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)=0
Runs the algorithm using the specified parameters.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
virtual QList< QgsProcessingAlgorithm::ExternalLink > externalLinks() const
Returns a list of external links describing the algorithm's behavior or source.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QList< QgsAcademicReference > academicReferences() const
Returns the list of academic references describing the logic and processes used by the algorithm.
Contains information about the context in which a processing algorithm is executed.
Base class for providing feedback from a processing algorithm.
A rectangle specified with double values.