QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Go to the documentation of this file.
18 #ifndef QGSALGORITHMGEOMETRYBYEXPRESSION_H
19 #define QGSALGORITHMGEOMETRYBYEXPRESSION_H
37 QgsGeometryByExpressionAlgorithm() =
default;
40 QString
name()
const override;
42 QStringList
tags()
const override;
43 QString
group()
const override;
44 QString
groupId()
const override;
48 void initParameters(
const QVariantMap &configuration = QVariantMap() )
override;
67 #endif // QGSALGORITHMGEOMETRYBYEXPRESSION_H
Expression contexts are used to encapsulate the parameters around which a QgsExpression should be eva...
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 QgsWkbTypes::Type outputWkbType(QgsWkbTypes::Type inputWkbType) const
Maps the input WKB geometry type (inputWkbType) to the corresponding output WKB type generated by the...
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
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.
Type
The WKB type describes the number of dimensions a geometry has.
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.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
virtual QgsProcessingFeatureSource::Flag sourceFlags() const
Returns the processing feature source flags to be used in the algorithm.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
Contains information about the context in which a processing algorithm is executed.
QList< QgsFeature > QgsFeatureList
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
static QIcon getThemeIcon(const QString &name, const QColor &fillColor=QColor(), const QColor &strokeColor=QColor())
Helper to get a theme icon.
Class for parsing and evaluation of expressions (formerly called "search strings")....
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...