QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Go to the documentation of this file.
21 #ifndef QGSALGORITHMGRID_H
22 #define QGSALGORITHMGRID_H
39 QgsGridAlgorithm() =
default;
40 void initAlgorithm(
const QVariantMap &configuration = QVariantMap() )
override;
43 QString
name()
const override;
45 QStringList
tags()
const override;
46 QString
group()
const override;
47 QString
groupId()
const override;
78 #endif // QGISALGORITHMGRID_H
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
Base class for providing feedback from a processing algorithm.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual bool prepareAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
static QString iconPath(const QString &iconFile)
Returns path to the desired icon file.
A rectangle specified with double values.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QVariantMap processAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Runs the algorithm using the specified parameters.
Contains information about the context in which a processing algorithm is executed.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
This class represents a coordinate reference system (CRS).
Abstract base class for processing algorithms.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
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 void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.