QGIS API Documentation  3.4.15-Madeira (e83d02e274)
qgsalgorithmreverselinedirection.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsalgorithmreverselinedirection.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 QGSALGORITHMREVERSELINEDIRECTION_H
19 #define QGSALGORITHMREVERSELINEDIRECTION_H
20 
21 #define SIP_NO_FILE
22 
23 #include "qgis.h"
24 #include "qgsprocessingalgorithm.h"
25 
27 
31 class QgsReverseLineDirectionAlgorithm : public QgsProcessingFeatureBasedAlgorithm
32 {
33 
34  public:
35 
36  QgsReverseLineDirectionAlgorithm() = 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  QgsReverseLineDirectionAlgorithm *createInstance() const override SIP_FACTORY;
46  QList<int> inputLayerTypes() const override;
47 
48  protected:
49 
50  QString outputName() const override;
52  QgsFeatureList processFeature( const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
53 
54 };
55 
57 
58 #endif // QGSALGORITHMREVERSELINEDIRECTION_H
59 
60 
virtual QString outputName() const =0
Returns the translated, user visible name for any layers created by this algorithm.
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.
virtual QgsProcessingFeatureSource::Flag sourceFlags() const
Returns the processing feature source flags to be used in the algorithm.
QList< QgsFeature > QgsFeatureList
Definition: qgsfeature.h:571
virtual QString name() const =0
Returns the algorithm name, used for identifying 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...
The feature class encapsulates a single feature including its id, geometry and a list of field/values...
Definition: qgsfeature.h:55
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
#define SIP_FACTORY
Definition: qgis_sip.h:69
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
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 group() const
Returns the name of the group this algorithm belongs to.
SourceType
Data source types enum.
Definition: qgsprocessing.h:44
virtual QList< int > inputLayerTypes() const
Returns the valid input layer types for the source layer for this algorithm.
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.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.