Subgroup: Processing
Class: QgsProcessingDestinationParameter¶
-
class
qgis.core.
QgsProcessingDestinationParameter
(name: str, description: str = '', defaultValue: Any = None, optional: bool = False, createByDefault: bool = True)¶ Bases:
qgis._core.QgsProcessingParameterDefinition
Constructor for QgsProcessingDestinationParameter.
If
createByDefault
is false and the parameter isoptional
, then the destination output will not be created by default.QgsProcessingDestinationParameter(QgsProcessingDestinationParameter)
Base class for all parameter definitions which represent file or layer destinations, e.g. parameters which are used for the destination for layers output by an algorithm.
New in version 3.0: Methods
createByDefault
Returns true if the destination should be created by default. defaultFileExtension
Returns the default file extension for destination file paths associated with this parameter. fromVariantMap
generateTemporaryDestination
Generates a temporary destination value for this parameter. isDestination
originalProvider
Original (source) provider which this parameter has been derived from. setCreateByDefault
Sets whether the destination should be created by default. setSupportsNonFileBasedOutput
Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs. supportsNonFileBasedOutput
Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs. toOutputDefinition
Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter. toVariantMap
Signals
Attributes
-
createByDefault
(self) → bool¶ Returns true if the destination should be created by default. For optional parameters, a return value of false indicates that the destination should not be created by default.
See also
-
defaultFileExtension
(self) → str¶ Returns the default file extension for destination file paths associated with this parameter.
-
fromVariantMap
(self, map: Dict[str, Any]) → bool¶
-
generateTemporaryDestination
(self) → str¶ Generates a temporary destination value for this parameter. The returned value will be a file path or QGIS data provider URI suitable for temporary storage of created layers and files.
-
isDestination
(self) → bool¶
-
originalProvider
(self) → QgsProcessingProvider¶ Original (source) provider which this parameter has been derived from. In the case of destination parameters which are part of model algorithms, this will reflect the child algorithm’s provider which actually generates the parameter, as opposed to the provider which this parameter belongs to (i.e. the model provider)
New in version 3.2.
-
setCreateByDefault
(self, createByDefault: bool)¶ Sets whether the destination should be created by default. For optional parameters, a value of false indicates that the destination should not be created by default.
See also
-
setSupportsNonFileBasedOutput
(self, supportsNonFileBasedOutput: bool)¶ Sets whether the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.
See also
-
supportsNonFileBasedOutput
(self) → bool¶ Returns true if the destination parameter supports non filed-based outputs, such as memory layers or direct database outputs.
See also
-
toOutputDefinition
(self) → QgsProcessingOutputDefinition¶ Returns a new QgsProcessingOutputDefinition corresponding to the definition of the destination parameter.
-
toVariantMap
(self) → Dict[str, Any]¶
-