QGIS API Documentation 3.41.0-Master (af5edcb665c)
Loading...
Searching...
No Matches
qgsmetadataalgorithms.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmetadataalgorithms.h
3 ---------------------
4 begin : November 2024
5 copyright : (C) 2024 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 QGSMETADATAALGORITHMS_H
19#define QGSMETADATAALGORITHMS_H
20
21#define SIP_NO_FILE
22
23#include "qgis_sip.h"
24#include "qgsprocessingalgorithm.h"
25
27
31class QgsCopyLayerMetadataAlgorithm : public QgsProcessingAlgorithm
32{
33 public:
34 QgsCopyLayerMetadataAlgorithm() = default;
35 QString name() const override;
36 QString displayName() const override;
37 QStringList tags() const override;
38 QString group() const override;
39 QString groupId() const override;
40 QString shortHelpString() const override;
41 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
42 QgsCopyLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
43
44 protected:
45 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
46 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
47
48 private:
49 QString mLayerId;
50};
51
55class QgsApplyLayerMetadataAlgorithm : public QgsProcessingAlgorithm
56{
57 public:
58 QgsApplyLayerMetadataAlgorithm() = default;
59 QString name() const override;
60 QString displayName() const override;
61 QStringList tags() const override;
62 QString group() const override;
63 QString groupId() const override;
64 QString shortHelpString() const override;
65 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
66 QgsApplyLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
67
68 protected:
69 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
70 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
71
72 private:
73 QString mLayerId;
74};
75
79class QgsExportLayerMetadataAlgorithm : public QgsProcessingAlgorithm
80{
81 public:
82 QgsExportLayerMetadataAlgorithm() = default;
83 QString name() const override;
84 QString displayName() const override;
85 QStringList tags() const override;
86 QString group() const override;
87 QString groupId() const override;
88 QString shortHelpString() const override;
89 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
90 QgsExportLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
91
92 protected:
93 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
94
95 private:
96 QString mLayerId;
97};
98
102class QgsAddHistoryMetadataAlgorithm : public QgsProcessingAlgorithm
103{
104 public:
105 QgsAddHistoryMetadataAlgorithm() = default;
106 QString name() const override;
107 QString displayName() const override;
108 QStringList tags() const override;
109 QString group() const override;
110 QString groupId() const override;
111 QString shortHelpString() const override;
112 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
113 QgsAddHistoryMetadataAlgorithm *createInstance() const override SIP_FACTORY;
114
115 protected:
116 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
117 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
118
119 private:
120 QString mLayerId;
121};
122
126class QgsUpdateLayerMetadataAlgorithm : public QgsProcessingAlgorithm
127{
128 public:
129 QgsUpdateLayerMetadataAlgorithm() = default;
130 QString name() const override;
131 QString displayName() const override;
132 QStringList tags() const override;
133 QString group() const override;
134 QString groupId() const override;
135 QString shortHelpString() const override;
136 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
137 QgsUpdateLayerMetadataAlgorithm *createInstance() const override SIP_FACTORY;
138
139 protected:
140 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
141 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
142
143 private:
144 QString mLayerId;
145};
146
147
151class QgsSetMetadataFieldsAlgorithm : public QgsProcessingAlgorithm
152{
153 public:
154 QgsSetMetadataFieldsAlgorithm() = default;
155 QString name() const override;
156 QString displayName() const override;
157 QStringList tags() const override;
158 QString group() const override;
159 QString groupId() const override;
160 QString shortHelpString() const override;
161 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override;
162 QgsSetMetadataFieldsAlgorithm *createInstance() const override SIP_FACTORY;
163
164 protected:
165 bool prepareAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override;
166 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback * ) override;
167
168 private:
169 QString mLayerId;
170};
171
173
174#endif // QGSMETADATAALGORITHMS_H
QgsProcessingAlgorithm
Abstract base class for processing algorithms.
Definition qgsprocessingalgorithm.h:51
QgsProcessingAlgorithm::createInstance
virtual QgsProcessingAlgorithm * createInstance() const =0
Creates a new instance of the algorithm class.
QgsProcessingAlgorithm::group
virtual QString group() const
Returns the name of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:211
QgsProcessingAlgorithm::groupId
virtual QString groupId() const
Returns the unique ID of the group this algorithm belongs to.
Definition qgsprocessingalgorithm.h:220
QgsProcessingAlgorithm::shortHelpString
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
Definition qgsprocessingalgorithm.cpp:65
QgsProcessingAlgorithm::displayName
virtual QString displayName() const =0
Returns the translated algorithm name, which should be used for any user-visible display of the algor...
QgsProcessingAlgorithm::tags
virtual QStringList tags() const
Returns a list of tags which relate to the algorithm, and are used to assist users in searching for s...
Definition qgsprocessingalgorithm.h:158
QgsProcessingAlgorithm::initAlgorithm
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
QgsProcessingAlgorithm::name
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
QgsProcessingContext
Contains information about the context in which a processing algorithm is executed.
Definition qgsprocessingcontext.h:45
QgsProcessingFeedback
Base class for providing feedback from a processing algorithm.
Definition qgsprocessingfeedback.h:38
qgis_sip.h
SIP_FACTORY
#define SIP_FACTORY
Definition qgis_sip.h:76
Generated on Thu Dec 26 2024 02:19:01 for QGIS API Documentation by doxygen 1.9.8