QGIS API Documentation 3.39.0-Master (be2050b798e)
Loading...
Searching...
No Matches
qgsalgorithmextractspecificvertices.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsalgorithmextractspecificvertices.h
3 -------------------------
4 begin : November 2019
5 copyright : (C) 2019 by Alexander Bruy
6 email : alexander dot bruy 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 QGSALGORITHMEXTRACTSPECIFICVERTICES_H
19#define QGSALGORITHMEXTRACTSPECIFICVERTICES_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
25#include "qgsapplication.h"
26
28
32class QgsExtractSpecificVerticesAlgorithm : public QgsProcessingFeatureBasedAlgorithm
33{
34
35 public:
36
37 QgsExtractSpecificVerticesAlgorithm() = default;
38 QString name() const override;
39 QString displayName() const override;
40 QStringList tags() const override;
41 QString group() const override;
42 QString groupId() const override;
43 QString shortHelpString() const override;
45 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
46 QgsExtractSpecificVerticesAlgorithm *createInstance() const override SIP_FACTORY;
47
48 protected:
49
50 QString outputName() const override;
51 QgsFields outputFields( const QgsFields &inputFields ) const override;
52 Qgis::ProcessingSourceType outputLayerType() const override;
53 Qgis::WkbType outputWkbType( Qgis::WkbType inputWkbType ) const override;
54 Qgis::ProcessingFeatureSourceFlags sourceFlags() const override;
55 QgsFeatureSink::SinkFlags sinkFlags() const override;
56
57 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
58 QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
59
60 private:
61 Qgis::GeometryType mGeometryType;
62 QList< int > mIndices;
63};
64
66
67#endif // QGSALGORITHMEXTRACTSPECIFICVERTICES_H
ProcessingSourceType
Processing data source types.
Definition qgis.h:3080
GeometryType
The geometry types are used to group Qgis::WkbType in a coarse way.
Definition qgis.h:274
QFlags< ProcessingAlgorithmDocumentationFlag > ProcessingAlgorithmDocumentationFlags
Flags describing algorithm behavior for documentation purposes.
Definition qgis.h:3176
WkbType
The WKB type describes the number of dimensions a geometry has.
Definition qgis.h:201
QFlags< ProcessingFeatureSourceFlag > ProcessingFeatureSourceFlags
Flags which control how QgsProcessingFeatureSource fetches features.
Definition qgis.h:3253
QFlags< SinkFlag > SinkFlags
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:58
Container of fields for a vector layer.
Definition qgsfields.h:46
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 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 displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
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 QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual Qgis::ProcessingAlgorithmDocumentationFlags documentationFlags() const
Returns the flags describing algorithm behavior for documentation purposes.
Contains information about the context in which a processing algorithm is executed.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
virtual void initParameters(const QVariantMap &configuration=QVariantMap())
Initializes any extra parameters added by the algorithm subclass.
Base class for providing feedback from a processing algorithm.
#define SIP_FACTORY
Definition qgis_sip.h:76
QList< QgsFeature > QgsFeatureList