QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Go to the documentation of this file.
18 #ifndef QGSLINESUBSTRINGALGORITHM_H
19 #define QGSLINESUBSTRINGALGORITHM_H
36 QgsLineSubstringAlgorithm() =
default;
37 QString
name()
const override;
39 QStringList
tags()
const override;
40 QString
group()
const override;
41 QString
groupId()
const override;
47 void initParameters(
const QVariantMap &configuration = QVariantMap() )
override;
57 double mStartDistance = 0.0;
58 bool mDynamicStartDistance =
false;
61 double mEndDistance = 0.0;
62 bool mDynamicEndDistance =
false;
69 #endif // QGSLINESUBSTRINGALGORITHM_H
virtual QString shortDescription() const
Returns an optional translated short description of the algorithm.
A store for object properties.
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 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 bool prepareAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
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 QgsProcessing::SourceType outputLayerType() const
Returns the layer type for layers generated by this algorithm, if this is possible to determine in ad...
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 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...
SourceType
Data source types enum.
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...