| QGIS API Documentation
    3.20.0-Odense (decaadbb31)
    | 
This is the complete list of members for QgsProcessingFeatureBasedAlgorithm, including all inherited members.
| addOutput(QgsProcessingOutputDefinition *outputDefinition) | QgsProcessingAlgorithm | protected | 
| addParameter(QgsProcessingParameterDefinition *parameterDefinition, bool createOutput=true) | QgsProcessingAlgorithm | protected | 
| asPythonCommand(const QVariantMap ¶meters, QgsProcessingContext &context) const | QgsProcessingAlgorithm | virtual | 
| Available enum value | QgsProcessingAlgorithm | |
| canExecute(QString *errorMessage=nullptr) const | QgsProcessingAlgorithm | virtual | 
| checkParameterValues(const QVariantMap ¶meters, QgsProcessingContext &context, QString *message=nullptr) const | QgsProcessingAlgorithm | virtual | 
| countVisibleParameters() const | QgsProcessingAlgorithm | |
| create(const QVariantMap &configuration=QVariantMap()) const SIP_THROW(QgsProcessingException) | QgsProcessingAlgorithm | |
| createCustomParametersWidget(QWidget *parent=nullptr) const | QgsProcessingAlgorithm | virtual | 
| createExpressionContext(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeatureSource *source=nullptr) const | QgsProcessingAlgorithm | virtual | 
| createInstance() const =0 | QgsProcessingAlgorithm | protectedpure virtual | 
| destinationParameterDefinitions() const | QgsProcessingAlgorithm | |
| displayName() const =0 | QgsProcessingAlgorithm | pure virtual | 
| Flag enum name | QgsProcessingAlgorithm | |
| FlagCanCancel enum value | QgsProcessingAlgorithm | |
| FlagCustomException enum value | QgsProcessingAlgorithm | |
| FlagDeprecated enum value | QgsProcessingAlgorithm | |
| FlagDisplayNameIsLiteral enum value | QgsProcessingAlgorithm | |
| FlagHideFromModeler enum value | QgsProcessingAlgorithm | |
| FlagHideFromToolbox enum value | QgsProcessingAlgorithm | |
| FlagKnownIssues enum value | QgsProcessingAlgorithm | |
| FlagNotAvailableInStandaloneTool enum value | QgsProcessingAlgorithm | |
| FlagNoThreading enum value | QgsProcessingAlgorithm | |
| FlagPruneModelBranchesBasedOnAlgorithmResults enum value | QgsProcessingAlgorithm | |
| FlagRequiresMatchingCrs enum value | QgsProcessingAlgorithm | |
| FlagRequiresProject enum value | QgsProcessingAlgorithm | |
| flags() const override | QgsProcessingFeatureBasedAlgorithm | virtual | 
| FlagSkipGenericModelLogging enum value | QgsProcessingAlgorithm | |
| FlagSupportsBatch enum value | QgsProcessingAlgorithm | |
| FlagSupportsInPlaceEdits enum value | QgsProcessingAlgorithm | |
| group() const | QgsProcessingAlgorithm | inlinevirtual | 
| groupId() const | QgsProcessingAlgorithm | inlinevirtual | 
| hasHtmlOutputs() const | QgsProcessingAlgorithm | |
| helpString() const | QgsProcessingAlgorithm | virtual | 
| helpUrl() const | QgsProcessingAlgorithm | virtual | 
| icon() const | QgsProcessingAlgorithm | virtual | 
| id() const | QgsProcessingAlgorithm | |
| initAlgorithm(const QVariantMap &configuration=QVariantMap()) override | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| initParameters(const QVariantMap &configuration=QVariantMap()) | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| inputLayerTypes() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| inputParameterDescription() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| inputParameterName() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| invalidRasterError(const QVariantMap ¶meters, const QString &name) | QgsProcessingAlgorithm | protectedstatic | 
| invalidSinkError(const QVariantMap ¶meters, const QString &name) | QgsProcessingAlgorithm | protectedstatic | 
| invalidSourceError(const QVariantMap ¶meters, const QString &name) | QgsProcessingAlgorithm | protectedstatic | 
| name() const =0 | QgsProcessingAlgorithm | pure virtual | 
| NotAvailable enum value | QgsProcessingAlgorithm | |
| operator=(const QgsProcessingAlgorithm &other)=delete | QgsProcessingAlgorithm | |
| outputCrs(const QgsCoordinateReferenceSystem &inputCrs) const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| outputDefinition(const QString &name) const | QgsProcessingAlgorithm | |
| outputDefinitions() const | QgsProcessingAlgorithm | inline | 
| outputFields(const QgsFields &inputFields) const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| outputLayerType() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| outputName() const =0 | QgsProcessingFeatureBasedAlgorithm | protectedpure virtual | 
| outputWkbType(QgsWkbTypes::Type inputWkbType) const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| parameterAsBool(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsBoolean(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsColor(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsCompatibleSourceLayerPath(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr) | QgsProcessingAlgorithm | protected | 
| parameterAsCompatibleSourceLayerPathAndLayerName(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr, QString *layerName=nullptr) | QgsProcessingAlgorithm | protected | 
| parameterAsConnectionName(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsCrs(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsDatabaseTableName(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsDateTime(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsDouble(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsEnum(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsEnums(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsEnumString(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsEnumStrings(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsExpression(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsExtent(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) const | QgsProcessingAlgorithm | protected | 
| parameterAsExtentCrs(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsExtentGeometry(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) | QgsProcessingAlgorithm | protected | 
| parameterAsFields(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsFile(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsFileList(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsFileOutput(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsGeometry(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) const | QgsProcessingAlgorithm | protected | 
| parameterAsGeometryCrs(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsInt(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsInts(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsLayer(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsLayerList(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsLayout(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsLayoutItem(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, QgsPrintLayout *layout) | QgsProcessingAlgorithm | protected | 
| parameterAsMatrix(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsMeshLayer(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsOutputLayer(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsPoint(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) const | QgsProcessingAlgorithm | protected | 
| parameterAsPointCrs(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsRange(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsRasterLayer(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsSchema(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) | QgsProcessingAlgorithm | protected | 
| parameterAsSink(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context, QString &destinationIdentifier, const QgsFields &fields, QgsWkbTypes::Type geometryType=QgsWkbTypes::NoGeometry, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem(), QgsFeatureSink::SinkFlags sinkFlags=QgsFeatureSink::SinkFlags(), const QVariantMap &createOptions=QVariantMap(), const QStringList &datasourceOptions=QStringList(), const QStringList &layerOptions=QStringList()) const SIP_THROW(QgsProcessingException) | QgsProcessingAlgorithm | protected | 
| parameterAsSource(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsString(const QVariantMap ¶meters, const QString &name, const QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterAsVectorLayer(const QVariantMap ¶meters, const QString &name, QgsProcessingContext &context) const | QgsProcessingAlgorithm | protected | 
| parameterDefinition(const QString &name) const | QgsProcessingAlgorithm | |
| parameterDefinitions() const | QgsProcessingAlgorithm | inline | 
| postProcess(QgsProcessingContext &context, QgsProcessingFeedback *feedback) | QgsProcessingAlgorithm | |
| postProcessAlgorithm(QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException) | QgsProcessingAlgorithm | protectedvirtual | 
| prepare(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) | QgsProcessingAlgorithm | |
| prepareAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException) | QgsProcessingAlgorithm | protectedvirtual | 
| prepareSource(const QVariantMap ¶meters, QgsProcessingContext &context) | QgsProcessingFeatureBasedAlgorithm | protected | 
| preprocessParameters(const QVariantMap ¶meters) | QgsProcessingAlgorithm | virtual | 
| processAlgorithm(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) override SIP_THROW(QgsProcessingException) | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| processFeature(const QgsFeature &feature, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0 | QgsProcessingFeatureBasedAlgorithm | pure virtual | 
| PropertyAvailability enum name | QgsProcessingAlgorithm | |
| provider() const | QgsProcessingAlgorithm | |
| QgsProcessingAlgorithm()=default | QgsProcessingAlgorithm | |
| QgsProcessingAlgorithm(const QgsProcessingAlgorithm &other)=delete | QgsProcessingAlgorithm | |
| QgsProcessingFeatureBasedAlgorithm()=default | QgsProcessingFeatureBasedAlgorithm | |
| removeParameter(const QString &name) | QgsProcessingAlgorithm | protected | 
| request() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| run(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback, bool *ok=nullptr, const QVariantMap &configuration=QVariantMap(), bool catchExceptions=true) const SIP_THROW(QgsProcessingException) | QgsProcessingAlgorithm | |
| runPrepared(const QVariantMap ¶meters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException) | QgsProcessingAlgorithm | |
| setProvider(QgsProcessingProvider *provider) | QgsProcessingAlgorithm | |
| shortDescription() const | QgsProcessingAlgorithm | virtual | 
| shortHelpString() const | QgsProcessingAlgorithm | virtual | 
| sinkFlags() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| sinkProperties(const QString &sink, const QVariantMap ¶meters, QgsProcessingContext &context, const QMap< QString, QgsProcessingAlgorithm::VectorProperties > &sourceProperties) const override | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| sourceCrs() const | QgsProcessingFeatureBasedAlgorithm | protected | 
| sourceFlags() const | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| supportInPlaceEdit(const QgsMapLayer *layer) const override | QgsProcessingFeatureBasedAlgorithm | protectedvirtual | 
| svgIconPath() const | QgsProcessingAlgorithm | virtual | 
| tags() const | QgsProcessingAlgorithm | inlinevirtual | 
| validateInputCrs(const QVariantMap ¶meters, QgsProcessingContext &context) const | QgsProcessingAlgorithm | virtual | 
| ~QgsProcessingAlgorithm() | QgsProcessingAlgorithm | virtual |