QGIS API Documentation  3.17.0-Master (a035f434f4)
qgsalgorithmarraytranslatedfeatures.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmarraytranslatedfeatures.h
3  ---------------------
4  begin : July 2018
5  copyright : (C) 2018 by Nyall Dawson
6  email : nyall dot dawson 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 QGSALGORITHMARRAYTRANSLATEDFEATURES_H
19 #define QGSALGORITHMARRAYTRANSLATEDFEATURES_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis_sip.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsArrayTranslatedFeaturesAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
33 
34  public:
35 
36  QgsArrayTranslatedFeaturesAlgorithm() = default;
37  QString name() const override;
38  QString displayName() const override;
39  QStringList tags() const override;
40  QString group() const override;
41  QString groupId() const override;
42  QString shortHelpString() const override;
43  QString shortDescription() const override;
44  QgsArrayTranslatedFeaturesAlgorithm *createInstance() const override SIP_FACTORY;
45  void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
46 
47  protected:
48  QString outputName() const override;
49  bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
50  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
51  QgsWkbTypes::Type outputWkbType( QgsWkbTypes::Type inputWkbType ) const override;
52  QgsFields outputFields( const QgsFields &inputFields ) const override;
53  QgsFeatureSink::SinkFlags sinkFlags() const override;
54 
55  private:
56 
57  int mCount = 0;
58  bool mDynamicCount = false;
59  QgsProperty mCountProperty;
60 
61  double mDeltaX = 0.0;
62  bool mDynamicDeltaX = false;
63  QgsProperty mDeltaXProperty;
64 
65  double mDeltaY = 0.0;
66  bool mDynamicDeltaY = false;
67  QgsProperty mDeltaYProperty;
68 
69  double mDeltaZ = 0.0;
70  bool mDynamicDeltaZ = false;
71  QgsProperty mDeltaZProperty;
72 
73  double mDeltaM = 0.0;
74  bool mDynamicDeltaM = false;
75  QgsProperty mDeltaMProperty;
76 
77 };
78 
79 
81 
82 #endif // QGSALGORITHMARRAYTRANSLATEDFEATURES_H
83 
84 
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 bool prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)
Prepares the algorithm to run using the specified parameters.
Base class for providing feedback from a processing algorithm.
virtual QgsFeatureList processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0
Processes an individual input feature from the source.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:583
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Container of fields for a vector layer.
Definition: qgsfields.h:44
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Type
The WKB type describes the number of dimensions a geometry has.
Definition: qgswkbtypes.h:69
virtual QgsWkbTypes::Type outputWkbType(QgsWkbTypes::Type inputWkbType) const
Maps the input WKB geometry type (inputWkbType) to the corresponding output WKB type generated by the...
#define SIP_FACTORY
Definition: qgis_sip.h:76
A store for object properties.
Definition: qgsproperty.h:231
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
virtual QgsFeatureSink::SinkFlags sinkFlags() const
Returns the feature sink flags to be used for the output.
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
virtual QString shortDescription() const
Returns an optional translated short description of the 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.
An abstract QgsProcessingAlgorithm base class for processing algorithms which operate "feature-by-fea...
Contains information about the context in which a processing algorithm is executed.