QGIS API Documentation  3.21.0-Master (5b68dc587e)
QgsProcessingAlgorithm Member List

This is the complete list of members for QgsProcessingAlgorithm, including all inherited members.

addOutput(QgsProcessingOutputDefinition *outputDefinition)QgsProcessingAlgorithmprotected
addParameter(QgsProcessingParameterDefinition *parameterDefinition, bool createOutput=true)QgsProcessingAlgorithmprotected
asPythonCommand(const QVariantMap &parameters, QgsProcessingContext &context) constQgsProcessingAlgorithmvirtual
Available enum valueQgsProcessingAlgorithm
canExecute(QString *errorMessage=nullptr) constQgsProcessingAlgorithmvirtual
checkParameterValues(const QVariantMap &parameters, QgsProcessingContext &context, QString *message=nullptr) constQgsProcessingAlgorithmvirtual
countVisibleParameters() constQgsProcessingAlgorithm
create(const QVariantMap &configuration=QVariantMap()) const SIP_THROW(QgsProcessingException)QgsProcessingAlgorithm
createCustomParametersWidget(QWidget *parent=nullptr) constQgsProcessingAlgorithmvirtual
createExpressionContext(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeatureSource *source=nullptr) constQgsProcessingAlgorithmvirtual
createInstance() const =0QgsProcessingAlgorithmprotectedpure virtual
destinationParameterDefinitions() constQgsProcessingAlgorithm
displayName() const =0QgsProcessingAlgorithmpure virtual
Flag enum nameQgsProcessingAlgorithm
FlagCanCancel enum valueQgsProcessingAlgorithm
FlagCustomException enum valueQgsProcessingAlgorithm
FlagDeprecated enum valueQgsProcessingAlgorithm
FlagDisplayNameIsLiteral enum valueQgsProcessingAlgorithm
FlagHideFromModeler enum valueQgsProcessingAlgorithm
FlagHideFromToolbox enum valueQgsProcessingAlgorithm
FlagKnownIssues enum valueQgsProcessingAlgorithm
FlagNotAvailableInStandaloneTool enum valueQgsProcessingAlgorithm
FlagNoThreading enum valueQgsProcessingAlgorithm
FlagPruneModelBranchesBasedOnAlgorithmResults enum valueQgsProcessingAlgorithm
FlagRequiresMatchingCrs enum valueQgsProcessingAlgorithm
FlagRequiresProject enum valueQgsProcessingAlgorithm
flags() constQgsProcessingAlgorithmvirtual
FlagSkipGenericModelLogging enum valueQgsProcessingAlgorithm
FlagSupportsBatch enum valueQgsProcessingAlgorithm
FlagSupportsInPlaceEdits enum valueQgsProcessingAlgorithm
group() constQgsProcessingAlgorithminlinevirtual
groupId() constQgsProcessingAlgorithminlinevirtual
hasHtmlOutputs() constQgsProcessingAlgorithm
helpString() constQgsProcessingAlgorithmvirtual
helpUrl() constQgsProcessingAlgorithmvirtual
icon() constQgsProcessingAlgorithmvirtual
id() constQgsProcessingAlgorithm
initAlgorithm(const QVariantMap &configuration=QVariantMap())=0QgsProcessingAlgorithmprotectedpure virtual
invalidRasterError(const QVariantMap &parameters, const QString &name)QgsProcessingAlgorithmprotectedstatic
invalidSinkError(const QVariantMap &parameters, const QString &name)QgsProcessingAlgorithmprotectedstatic
invalidSourceError(const QVariantMap &parameters, const QString &name)QgsProcessingAlgorithmprotectedstatic
name() const =0QgsProcessingAlgorithmpure virtual
NotAvailable enum valueQgsProcessingAlgorithm
operator=(const QgsProcessingAlgorithm &other)=deleteQgsProcessingAlgorithm
outputDefinition(const QString &name) constQgsProcessingAlgorithm
outputDefinitions() constQgsProcessingAlgorithminline
parameterAsAnnotationLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsBool(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsBoolean(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsColor(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsCompatibleSourceLayerPath(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr)QgsProcessingAlgorithmprotected
parameterAsCompatibleSourceLayerPathAndLayerName(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr, QString *layerName=nullptr)QgsProcessingAlgorithmprotected
parameterAsConnectionName(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsCrs(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsDatabaseTableName(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsDateTime(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsDouble(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsEnum(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsEnums(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsEnumString(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsEnumStrings(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsExpression(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsExtent(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) constQgsProcessingAlgorithmprotected
parameterAsExtentCrs(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsExtentGeometry(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem())QgsProcessingAlgorithmprotected
parameterAsFields(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsFile(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsFileList(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsFileOutput(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsGeometry(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) constQgsProcessingAlgorithmprotected
parameterAsGeometryCrs(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsInt(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsInts(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsLayerList(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsLayout(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsLayoutItem(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, QgsPrintLayout *layout)QgsProcessingAlgorithmprotected
parameterAsMatrix(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsMeshLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsOutputLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsPoint(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) constQgsProcessingAlgorithmprotected
parameterAsPointCloudLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsPointCrs(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsRange(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsRasterLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsSchema(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsSink(const QVariantMap &parameters, 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)QgsProcessingAlgorithmprotected
parameterAsSource(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsString(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterAsVectorLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) constQgsProcessingAlgorithmprotected
parameterDefinition(const QString &name) constQgsProcessingAlgorithm
parameterDefinitions() constQgsProcessingAlgorithminline
postProcess(QgsProcessingContext &context, QgsProcessingFeedback *feedback)QgsProcessingAlgorithm
postProcessAlgorithm(QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)QgsProcessingAlgorithmprotectedvirtual
prepare(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback)QgsProcessingAlgorithm
prepareAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)QgsProcessingAlgorithmprotectedvirtual
preprocessParameters(const QVariantMap &parameters)QgsProcessingAlgorithmvirtual
processAlgorithm(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)=0QgsProcessingAlgorithmprotectedpure virtual
PropertyAvailability enum nameQgsProcessingAlgorithm
provider() constQgsProcessingAlgorithm
QgsProcessingAlgorithm()=defaultQgsProcessingAlgorithm
QgsProcessingAlgorithm(const QgsProcessingAlgorithm &other)=deleteQgsProcessingAlgorithm
QgsProcessingModelAlgorithm classQgsProcessingAlgorithmfriend
QgsProcessingProvider classQgsProcessingAlgorithmfriend
QgsProcessingToolboxProxyModel classQgsProcessingAlgorithmfriend
removeParameter(const QString &name)QgsProcessingAlgorithmprotected
run(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback, bool *ok=nullptr, const QVariantMap &configuration=QVariantMap(), bool catchExceptions=true) const SIP_THROW(QgsProcessingException)QgsProcessingAlgorithm
runPrepared(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)QgsProcessingAlgorithm
setProvider(QgsProcessingProvider *provider)QgsProcessingAlgorithm
shortDescription() constQgsProcessingAlgorithmvirtual
shortHelpString() constQgsProcessingAlgorithmvirtual
sinkProperties(const QString &sink, const QVariantMap &parameters, QgsProcessingContext &context, const QMap< QString, QgsProcessingAlgorithm::VectorProperties > &sourceProperties) constQgsProcessingAlgorithmvirtual
supportInPlaceEdit(const QgsMapLayer *layer) constQgsProcessingAlgorithmprotectedvirtual
svgIconPath() constQgsProcessingAlgorithmvirtual
tags() constQgsProcessingAlgorithminlinevirtual
TestQgsProcessing classQgsProcessingAlgorithmfriend
validateInputCrs(const QVariantMap &parameters, QgsProcessingContext &context) constQgsProcessingAlgorithmvirtual
writeFeatureError(QgsFeatureSink *sink, const QVariantMap &parameters, const QString &name)QgsProcessingAlgorithmprotectedstatic
~QgsProcessingAlgorithm()QgsProcessingAlgorithmvirtual