QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Go to the documentation of this file.
18 #ifndef QGSALGORITHMDROPFIELDS_H
19 #define QGSALGORITHMDROPFIELDS_H
36 QgsDropTableFieldsAlgorithm() =
default;
37 QgsProcessingAlgorithm::Flags
flags()
const override;
38 QString
name()
const override;
40 QStringList
tags()
const override;
41 QString
group()
const override;
42 QString
groupId()
const override;
50 void initParameters(
const QVariantMap &configuration = QVariantMap() )
override;
61 QStringList mFieldsToDelete;
62 mutable QList< int > mFieldIndices;
74 QgsRetainTableFieldsAlgorithm() =
default;
75 QgsProcessingAlgorithm::Flags
flags()
const override;
76 QString
name()
const override;
78 QStringList
tags()
const override;
79 QString
group()
const override;
80 QString
groupId()
const override;
88 void initParameters( const QVariantMap &configuration = QVariantMap() ) override;
89 QString outputName() const override;
95 bool supportInPlaceEdit( const
QgsMapLayer *layer ) const override;
99 QStringList mFieldsToRetain;
100 mutable QList<
int > mFieldIndices;
106 #endif // QGSALGORITHMDROPFIELDS_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...
Base class for providing feedback from a processing algorithm.
Container of fields for a vector 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.
bool supportInPlaceEdit(const QgsMapLayer *layer) const override
Checks whether this algorithm supports in-place editing on the given layer Default implementation for...
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.
QgsProcessingAlgorithm::Flags flags() const override
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
QList< QgsFeature > QgsFeatureList
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
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.
Flag
Flags controlling how QgsProcessingFeatureSource fetches features.
Base class for all map layer types. This is the base class for all map layer types (vector,...
QgsFeatureSource subclass which proxies methods to an underlying QgsFeatureSource,...
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...
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...