Skip to content

Commit 4e2605b

Browse files
committed
Add some notes on enums, numeric parameters
1 parent 689966c commit 4e2605b

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

doc/porting_processing.dox

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,17 @@
1515
- When constructing, QgsProcessingParameterField uses QgsProcessingParameterField.DataType to specify valid data types. The parent layer for the field should be indicated by passing the parent layer parameter name as the parentLayerParameterName argument in the constructor.
1616
- Retrieving field parameter values should be done with self.parameterAsString( parameters, PARAM_NAME, context) for single field values or self.parameterAsFields(parameters, PARAM_NAME, context) if allowMultiple was set to True when the parameter was constructed. parameterAsFields will return a list of all selected field names, or an empty list if no fields were selected.
1717

18+
- ParameterSelection has been replaced with QgsProcessingParameterEnum.
19+
- Retrieving the parameter value should be done with self.parameterAsEnum( parameters, PARAM_NAME, context). This will return an integer corresponding to the index of the value selected. If allowMultiple was set to True when the parameter was constructed then self.parameterAsEnums(parameters, PARAM_NAME, context) should be used instead. This will return a list of selected indexes, or an empty list if no options were selected.
20+
21+
- ParameterNumber has been replaced with QgsProcessingParameterNumber.
22+
- Be careful when constructing QgsProcessingParameterNumber - the arguments are in a different order to ParameterNumber.
23+
- When constructing a QgsProcessingParameterNumber the number type (integer or double) must be specified explicitly via the type argument.
24+
- Retrieving the parameter value should be done with self.parameterAsInt( parameters, PARAM_NAME, context) for integer parameters or self.parameterAsDouble(parameters, PARAM_NAME, context) for double value parameters.
25+
26+
1827
Map parameters from old classes to new classes
19-
- ParameterNumber -> QgsProcessingParameterNumber
20-
- constructor arguments in different order
21-
- type specified explicitly, not via min/max/default type
22-
- ParameterBoolean -> QgsProcessingParameterBoolean
28+
- ParameterBoolean -> QgsProcessingParameterBoolean
2329
- ParameterCrs -> QgsProcessingParameterCrs
2430

2531
- Use featuresources and sinks wherever possible

0 commit comments

Comments
 (0)