QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
Go to the documentation of this file.
18 #ifndef QGSALGORITHMPOINTSINPOLYGON_H
19 #define QGSALGORITHMPOINTSINPOLYGON_H
36 QgsPointsInPolygonAlgorithm() =
default;
37 void initParameters(
const QVariantMap &configuration = QVariantMap() )
override;
38 QString
name()
const override;
40 QStringList
tags()
const override;
42 QIcon
icon()
const override;
43 QString
group()
const override;
44 QString
groupId()
const override;
64 QString mWeightFieldName;
65 QString mClassFieldName;
66 int mWeightFieldIndex = -1;
67 int mClassFieldIndex = -1;
68 mutable int mDestFieldIndex = -1;
72 std::unique_ptr< QgsProcessingFeatureSource > mPointSource;
78 #endif // QGSALGORITHMPOINTSINPOLYGON_H
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 QString inputParameterDescription() const
Returns the translated description of the parameter corresponding to the input layer.
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.
virtual bool prepareAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
QList< int > QgsAttributeList
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.
virtual QgsCoordinateReferenceSystem outputCrs(const QgsCoordinateReferenceSystem &inputCrs) const
Maps the input source coordinate reference system (inputCrs) to a corresponding output CRS generated ...
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.
virtual QgsFields outputFields(const QgsFields &inputFields) const
Maps the input source fields (inputFields) to corresponding output fields generated by the algorithm.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString inputParameterName() const
Returns the name of the parameter corresponding to the input layer.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
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...