QGIS/python/plugins/processing/preconfigured/PreconfiguredAlgorithm.py
Nyall Dawson 1e13d733c2 Move declaration of algorithm parameters/outputs to a new virtual
initAlgorithm() method

This allows 2 benefits:
- algorithms can be subclassed and have subclasses add additional
parameters/outputs to the algorithm. With the previous approach
of declaring parameters/outputs in the constructor, it's not
possible to call virtual methods to add additional parameters/
outputs (since you can't call virtual methods from a constructor).

- initAlgorithm takes a variant map argument, allowing the algorithm
to dynamically adjust its declared parameters and outputs according
to this configuration map. This potentially allows model algorithms which
can be configured to have variable numbers of parameters and
outputs at run time. E.g. a "router" algorithm which directs
features to one of any number of output sinks depending on some
user configured criteria.
2017-07-10 16:31:14 +10:00

69 lines
2.4 KiB
Python

# -*- coding: utf-8 -*-
"""
***************************************************************************
PreconfiguredAlgorithm.py
---------------------
Date : April 2016
Copyright : (C) 2016 by Victor Olaya
Email : volayaf at gmail dot com
***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************
"""
__author__ = 'Victor Olaya'
__date__ = 'April 2016'
__copyright__ = '(C) 2016, Victor Olaya'
# This will get replaced with a git SHA1 when you do a git archive
__revision__ = '$Format:%H$'
import os
from qgis.core import (QgsProcessingAlgorithm,
QgsApplication)
from processing.core.GeoAlgorithm import GeoAlgorithm
from copy import deepcopy
import json
class PreconfiguredAlgorithm(GeoAlgorithm):
def __init__(self, descriptionFile):
self.descriptionFile = descriptionFile
with open(self.descriptionFile) as f:
self.description = json.load(f)
GeoAlgorithm.__init__(self)
self._name = self.description["name"]
self._group = self.description["group"]
def group(self):
return self._group
def displayName(self):
return self._name
def name(self):
return os.path.splitext(os.path.basename(self.descriptionFile))[0].lower()
def flags(self):
return QgsProcessingAlgorithm.FlagHideFromModeler
def execute(self, parameters, context=None, feedback=None, model=None):
new_parameters = deepcopy(parameters)
self.alg = QgsApplication.processingRegistry().createAlgorithmById(self.description["algname"])
for name, value in list(self.description["parameters"].items()):
new_parameters[name] = value
for name, value in list(self.description["outputs"].items()):
self.alg.setOutputValue(name, value)
self.alg.execute(new_parameters, feedback)
self.outputs = self.alg.outputs