Class: QgsProcessingFeatureSourceDefinition¶
-
class
qgis.core.
QgsProcessingFeatureSourceDefinition
(source: str = '', selectedFeaturesOnly: bool = False, featureLimit: int = - 1, flags: Union[QgsProcessingFeatureSourceDefinition.Flags, QgsProcessingFeatureSourceDefinition.Flag] = QgsProcessingFeatureSourceDefinition.Flags(), geometryCheck: QgsFeatureRequest.InvalidGeometryCheck = QgsFeatureRequest.GeometryAbortOnInvalid)¶ Bases:
sip.wrapper
Constructor for
QgsProcessingFeatureSourceDefinition
, accepting a static stringsource
.If
selectedFeaturesOnly
isTrue
, then only selected features from the source will be used.The optional
featureLimit
can be set to a value > 0 to place a hard limit on the maximum number of features which will be read from the source.The
flags
argument can be used to specify flags which dictate the source behavior.If the QgsProcessingFeatureSourceDefinition.Flag.FlagOverrideDefaultGeometryCheck is set in
flags
, then the value ofgeometryCheck
will override the default geometry check method (as dictated byQgsProcessingContext
) for this source.QgsProcessingFeatureSourceDefinition(source:
QgsProperty
, selectedFeaturesOnly: bool = False, featureLimit: int = -1, flags: Union[QgsProcessingFeatureSourceDefinition.Flags, QgsProcessingFeatureSourceDefinition.Flag] = QgsProcessingFeatureSourceDefinition.Flags(), geometryCheck: QgsFeatureRequest.InvalidGeometryCheck = QgsFeatureRequest.GeometryAbortOnInvalid) Constructor forQgsProcessingFeatureSourceDefinition
, accepting aQgsProperty
source.If
selectedFeaturesOnly
isTrue
, then only selected features from the source will be used.The optional
featureLimit
can be set to a value > 0 to place a hard limit on the maximum number of features which will be read from the source.The
flags
argument can be used to specify flags which dictate the source behavior.If the QgsProcessingFeatureSourceDefinition.Flag.FlagOverrideDefaultGeometryCheck is set in
flags
, then the value ofgeometryCheck
will override the default geometry check method (as dictated byQgsProcessingContext
) for this source.QgsProcessingFeatureSourceDefinition(
QgsProcessingFeatureSourceDefinition
)Encapsulates settings relating to a feature source input to a processing algorithm.
New in version 3.0.
- Parameters
source (str = '') –
selectedFeaturesOnly (bool = False) –
featureLimit (int = -1) –
flags (Union[QgsProcessingFeatureSourceDefinition.Flags) –
geometryCheck –
-
class
Flag
¶ Bases:
int
-
FlagCreateIndividualOutputPerInputFeature
= 2¶
-
FlagOverrideDefaultGeometryCheck
= 1¶
-
class
Flags
¶ Bases:
sip.wrapper
QgsProcessingFeatureSourceDefinition.Flags(Union[QgsProcessingFeatureSourceDefinition.Flags, QgsProcessingFeatureSourceDefinition.Flag]) QgsProcessingFeatureSourceDefinition.Flags(QgsProcessingFeatureSourceDefinition.Flags)
-
featureLimit
¶
-
flags
¶
-
geometryCheck
¶
-
loadVariant
(self, map: Dict[str, Any]) → bool¶ Loads this source definition from a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.readVariant to load it from an XML document.
See also
New in version 3.14.
- Parameters
map (Dict[str) –
- Return type
bool
-
selectedFeaturesOnly
¶
-
source
¶
-
toVariant
(self) → Any¶ Saves this source definition to a QVariantMap, wrapped in a QVariant. You can use QgsXmlUtils.writeVariant to save it to an XML document.
See also
New in version 3.14.
- Return type
Any