QGIS API Documentation 4.3.0-Master (0cef2469b72)
Loading...
Searching...
No Matches
qgsprocessingmodelalgorithm.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsprocessingmodelalgorithm.h
3 -----------------------------
4 begin : June 2017
5 copyright : (C) 2017 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 QGSPROCESSINGMODELALGORITHM_H
19#define QGSPROCESSINGMODELALGORITHM_H
20
21#include "qgis.h"
22#include "qgis_core.h"
29
31
37class CORE_EXPORT QgsProcessingModelAlgorithm : public QgsProcessingAlgorithm
38{
39 Q_GADGET
40
41 public:
45 QgsProcessingModelAlgorithm( const QString &name = QString(), const QString &group = QString(), const QString &groupId = QString() );
46
47 void initAlgorithm( const QVariantMap &configuration = QVariantMap() ) override; //#spellok
48
50 QString name() const override;
51 QString displayName() const override;
52 QString group() const override;
53 QString groupId() const override;
54 QIcon icon() const override;
55 QString svgIconPath() const override;
56 QString shortHelpString() const override;
57 QString shortDescription() const override;
58 QString helpUrl() const override;
59
60 bool canExecute( QString *errorMessage SIP_OUT = nullptr ) const override;
61 QString asPythonCommand( const QVariantMap &parameters, QgsProcessingContext &context ) const override;
62 QgsExpressionContext createExpressionContext( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeatureSource *source = nullptr ) const override;
63
68 void setName( const QString &name );
69
74 void setGroup( const QString &group );
75
83 bool validate( QStringList &issues SIP_OUT ) const;
84
92 QMap<QString, QgsProcessingModelChildAlgorithm> childAlgorithms() const;
93
103 void setChildAlgorithms( const QMap<QString, QgsProcessingModelChildAlgorithm> &childAlgorithms );
104
111 void setChildAlgorithm( const QgsProcessingModelChildAlgorithm &algorithm );
112
123 QString addChildAlgorithm( QgsProcessingModelChildAlgorithm &algorithm );
124
131 QgsProcessingModelChildAlgorithm &childAlgorithm( const QString &id );
132
140 bool removeChildAlgorithm( const QString &id );
141
149 void deactivateChildAlgorithm( const QString &id );
150
157 bool activateChildAlgorithm( const QString &id );
158
169 QSet< QString > dependentChildAlgorithms( const QString &childId, const QString &conditionalBranch = QString() ) const;
170
176 QSet< QString > dependsOnChildAlgorithms( const QString &childId ) const;
177
183 QList< QgsProcessingModelChildDependency > availableDependenciesForChildAlgorithm( const QString &childId ) const;
184
194 bool validateChildAlgorithm( const QString &childId, QStringList &issues SIP_OUT ) const;
195
202 void addModelParameter( QgsProcessingParameterDefinition *definition SIP_TRANSFER, const QgsProcessingModelParameter &component );
203
210 void updateModelParameter( QgsProcessingParameterDefinition *definition SIP_TRANSFER );
211
218 void removeModelParameter( const QString &name );
219
227 void changeParameterName( const QString &oldName, const QString &newName );
228
234 bool childAlgorithmsDependOnParameter( const QString &name ) const;
235
242 bool otherParametersDependOnParameter( const QString &name ) const;
243
250 QMap<QString, QgsProcessingModelParameter> parameterComponents() const;
251
260 void setParameterComponents( const QMap<QString, QgsProcessingModelParameter> &parameterComponents );
261
269 void setParameterComponent( const QgsProcessingModelParameter &component );
270
278 QgsProcessingModelParameter &parameterComponent( const QString &name );
279
286 QList< QgsProcessingModelParameter > orderedParameters() const;
287
297 void setParameterOrder( const QStringList &order );
298
305 QList< QgsProcessingModelOutput > orderedOutputs() const;
306
316 void setOutputOrder( const QStringList &order );
317
324 QString outputGroup() const;
325
332 void setOutputGroup( const QString &group );
333
339 void updateDestinationParameters();
340
349 void addGroupBox( const QgsProcessingModelGroupBox &groupBox );
350
357 QList< QgsProcessingModelGroupBox > groupBoxes() const;
358
366 void removeGroupBox( const QString &uuid );
367
372 bool toFile( const QString &path ) const;
373
378 bool fromFile( const QString &path );
379
386 static std::unique_ptr< QgsProcessingModelAlgorithm > loadModel( const QString &path );
387
395 QVariant toVariant() const;
396
404 bool loadVariant( const QVariant &variant );
405
413 QString modelQgisVersion() const { return mModelQgisVersion; }
414
420 QVariantMap &helpContent() { return mHelpContent; }
421
427 SIP_SKIP QVariantMap helpContent() const;
428
434 void setHelpContent( const QVariantMap &contents );
435
440 QString sourceFilePath() const;
441
446 void setSourceFilePath( const QString &path );
447
456 bool modelNameMatchesFilePath() const;
457
465 QStringList asPythonCode( QgsProcessing::PythonOutputType outputType, int indentSize ) const;
466
475 QList< QgsProcessingModelChildParameterSource > availableSourcesForChild( const QString &childId, const QgsProcessingParameterDefinition *param ) const;
476
487 QList< QgsProcessingModelChildParameterSource > availableSourcesForChild(
488 const QString &childId, const QStringList &parameterTypes = QStringList(), const QStringList &outputTypes = QStringList(), const QList< int > &dataTypes = QList< int >()
489 ) const;
490
495 class CORE_EXPORT VariableDefinition
496 {
497 public:
502 VariableDefinition(
503 const QVariant &value = QVariant(),
504 const QgsProcessingModelChildParameterSource &source = QgsProcessingModelChildParameterSource::fromStaticValue( QVariant() ),
505 const QString &description = QString()
506 )
507 : value( value )
508 , source( source )
509 , description( description )
510 {}
511
513 QVariant value;
514
516 QgsProcessingModelChildParameterSource source;
517
519 QString description;
520 };
521
535 QMap< QString, QgsProcessingModelAlgorithm::VariableDefinition > variablesForChildAlgorithm(
536 const QString &childId, QgsProcessingContext *context = nullptr, const QVariantMap &modelParameters = QVariantMap(), const QVariantMap &results = QVariantMap()
537 ) const;
538
543 std::unique_ptr<QgsExpressionContextScope> createExpressionContextScopeForChildAlgorithm(
544 const QString &childId, QgsProcessingContext &context, const QVariantMap &modelParameters = QVariantMap(), const QVariantMap &results = QVariantMap()
545 ) const;
546
556 QVariantMap variables() const;
557
567 void setVariables( const QVariantMap &variables );
568
580 QVariantMap designerParameterValues() const;
581
593 void setDesignerParameterValues( const QVariantMap &values ) { mDesignerParameterValues = values; }
594
600 const QgsProcessingParameterDefinition *modelParameterFromChildIdAndOutputName( const QString &childId, const QString &childOutputName ) const;
601
609 static QString safeName( const QString &name, bool capitalize = false );
610
611
612#ifndef SIP_RUN
613
615 enum class InternalVersion
616 {
617 Version1,
618 Version2,
619 };
620 Q_ENUM( InternalVersion )
621
622#endif
623
624 protected:
625 QgsProcessingAlgorithm *createInstance() const override SIP_FACTORY;
626
627 QVariantMap processAlgorithm( const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback ) override SIP_THROW( QgsProcessingException );
628
629 private:
630 InternalVersion mInternalVersion = InternalVersion::Version2;
631
632 QString mModelName;
633 QString mModelGroup;
634 QString mModelGroupId;
635 QString mModelQgisVersion;
636
637 QMap< QString, QgsProcessingModelChildAlgorithm > mChildAlgorithms;
638
640 QMap< QString, QgsProcessingModelParameter > mParameterComponents;
641
642 QVariantMap mHelpContent;
643
645 QString mSourceFile;
646
647 QVariantMap mResults;
648
649 QVariantMap mVariables;
650
651 QVariantMap mDesignerParameterValues;
652
653 QMap< QString, QgsProcessingModelGroupBox > mGroupBoxes;
654
655 QStringList mParameterOrder;
656 QStringList mOutputOrder;
657 QString mOutputGroup;
658
659 void dependsOnChildAlgorithmsRecursive( const QString &childId, QSet<QString> &depends ) const;
660 void dependentChildAlgorithmsRecursive( const QString &childId, QSet<QString> &depends, const QString &branch ) const;
661
662 QVariantMap parametersForChildAlgorithm(
663 const QgsProcessingModelChildAlgorithm &child,
664 const QVariantMap &modelParameters,
665 const QVariantMap &results,
666 const QgsExpressionContext &expressionContext,
667 QString &error,
668 const QgsProcessingContext *context = nullptr
669 ) const;
670
675 bool childOutputIsRequired( const QString &childId, const QString &outputName ) const;
676
686 static bool vectorOutputIsCompatibleType( const QList<int> &acceptableDataTypes, Qgis::ProcessingSourceType outputType );
687
691 void reattachAlgorithms() const;
692
693 friend class TestQgsProcessingModelAlgorithm;
694};
695
697
698#endif // QGSPROCESSINGMODELALGORITHM_H
QFlags< ProcessingAlgorithmFlag > ProcessingAlgorithmFlags
Flags indicating how and when an algorithm operates and should be exposed to users.
Definition qgis.h:3860
Abstract base class for processing algorithms.
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 helpUrl() const
Returns a url pointing to the algorithm's help page.
virtual QIcon icon() const
Returns an icon for the algorithm.
virtual QString shortHelpString() const
Returns a localised short helper string for the algorithm.
virtual Qgis::ProcessingAlgorithmFlags flags() const
Returns the flags indicating how and when the algorithm operates and should be exposed to users.
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 QgsExpressionContext createExpressionContext(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeatureSource *source=nullptr) const
Creates an expression context relating to the algorithm.
virtual QString svgIconPath() const
Returns a path to an SVG version of the algorithm's icon.
virtual void initAlgorithm(const QVariantMap &configuration=QVariantMap())=0
Initializes the algorithm using the specified configuration.
virtual QString asPythonCommand(const QVariantMap &parameters, QgsProcessingContext &context) const
Returns a Python command string which can be executed to run the algorithm using the specified parame...
virtual bool canExecute(QString *errorMessage=nullptr) const
Returns true if the algorithm can execute.
virtual QString name() const =0
Returns the algorithm name, used for identifying the algorithm.
PythonOutputType
Available Python output types.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into allowing algorithms to be written in pure substantial changes are required in order to port existing x Processing algorithms for QGIS x The most significant changes are outlined not GeoAlgorithm For algorithms which operate on features one by consider subclassing the QgsProcessingFeatureBasedAlgorithm class This class allows much of the boilerplate code for looping over features from a vector layer to be bypassed and instead requires implementation of a processFeature method Ensure that your algorithm(or algorithm 's parent class) implements the new pure virtual createInstance(self) call
#define SIP_SKIP
Definition qgis_sip.h:138
#define SIP_TRANSFER
Definition qgis_sip.h:35
#define SIP_OUT
Definition qgis_sip.h:57
#define SIP_FACTORY
Definition qgis_sip.h:83
#define SIP_THROW(name,...)
Definition qgis_sip.h:215