QGIS API Documentation  3.4.15-Madeira (e83d02e274)
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) const QgsProcessingAlgorithmvirtual
canExecute(QString *errorMessage=nullptr) const QgsProcessingAlgorithmvirtual
checkParameterValues(const QVariantMap &parameters, QgsProcessingContext &context, QString *message=nullptr) const QgsProcessingAlgorithmvirtual
countVisibleParameters() const QgsProcessingAlgorithm
create(const QVariantMap &configuration=QVariantMap()) const SIP_THROW(QgsProcessingException)QgsProcessingAlgorithm
createCustomParametersWidget(QWidget *parent=nullptr) const QgsProcessingAlgorithmvirtual
createExpressionContext(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeatureSource *source=nullptr) const QgsProcessingAlgorithm
createInstance() const =0QgsProcessingAlgorithmprotectedpure virtual
destinationParameterDefinitions() const QgsProcessingAlgorithm
displayName() const =0QgsProcessingAlgorithmpure virtual
Flag enum nameQgsProcessingAlgorithm
FlagCanCancel enum valueQgsProcessingAlgorithm
FlagDeprecated enum valueQgsProcessingAlgorithm
FlagDisplayNameIsLiteral enum valueQgsProcessingAlgorithm
FlagHideFromModeler enum valueQgsProcessingAlgorithm
FlagHideFromToolbox enum valueQgsProcessingAlgorithm
FlagKnownIssues enum valueQgsProcessingAlgorithm
FlagNoThreading enum valueQgsProcessingAlgorithm
FlagRequiresMatchingCrs enum valueQgsProcessingAlgorithm
flags() const QgsProcessingAlgorithmvirtual
FlagSupportsBatch enum valueQgsProcessingAlgorithm
FlagSupportsInPlaceEdits enum valueQgsProcessingAlgorithm
group() const QgsProcessingAlgorithminlinevirtual
groupId() const QgsProcessingAlgorithminlinevirtual
hasHtmlOutputs() const QgsProcessingAlgorithm
helpString() const QgsProcessingAlgorithmvirtual
helpUrl() const QgsProcessingAlgorithmvirtual
icon() const QgsProcessingAlgorithmvirtual
id() const QgsProcessingAlgorithm
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
operator=(const QgsProcessingAlgorithm &other)=deleteQgsProcessingAlgorithm
outputDefinition(const QString &name) const QgsProcessingAlgorithm
outputDefinitions() const QgsProcessingAlgorithminline
parameterAsBool(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsCompatibleSourceLayerPath(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QStringList &compatibleFormats, const QString &preferredFormat=QString("shp"), QgsProcessingFeedback *feedback=nullptr)QgsProcessingAlgorithmprotected
parameterAsCrs(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsDouble(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsEnum(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsEnums(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsExpression(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsExtent(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) const QgsProcessingAlgorithmprotected
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) const QgsProcessingAlgorithmprotected
parameterAsFile(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsFileOutput(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsInt(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsInts(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsLayerList(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsMatrix(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsOutputLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsPoint(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context, const QgsCoordinateReferenceSystem &crs=QgsCoordinateReferenceSystem()) const QgsProcessingAlgorithmprotected
parameterAsPointCrs(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context)QgsProcessingAlgorithmprotected
parameterAsRange(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsRasterLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const 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=nullptr) const QgsProcessingAlgorithmprotected
parameterAsSource(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsString(const QVariantMap &parameters, const QString &name, const QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterAsVectorLayer(const QVariantMap &parameters, const QString &name, QgsProcessingContext &context) const QgsProcessingAlgorithmprotected
parameterDefinition(const QString &name) const QgsProcessingAlgorithm
parameterDefinitions() const QgsProcessingAlgorithminline
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
provider() const QgsProcessingAlgorithm
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()) const QgsProcessingAlgorithm
runPrepared(const QVariantMap &parameters, QgsProcessingContext &context, QgsProcessingFeedback *feedback) SIP_THROW(QgsProcessingException)QgsProcessingAlgorithm
setProvider(QgsProcessingProvider *provider)QgsProcessingAlgorithm
shortDescription() const QgsProcessingAlgorithmvirtual
shortHelpString() const QgsProcessingAlgorithmvirtual
supportInPlaceEdit(const QgsMapLayer *layer) const QgsProcessingAlgorithmprotectedvirtual
svgIconPath() const QgsProcessingAlgorithmvirtual
tags() const QgsProcessingAlgorithminlinevirtual
TestQgsProcessing classQgsProcessingAlgorithmfriend
validateInputCrs(const QVariantMap &parameters, QgsProcessingContext &context) const QgsProcessingAlgorithmvirtual
~QgsProcessingAlgorithm()QgsProcessingAlgorithmvirtual