QgsProcessingFeatureSourceDefinition Class Reference

Encapsulates settings relating to a feature source input to a processing algorithm. More...

#include <qgsprocessingparameters.h>

Public Member Functions
	QgsProcessingFeatureSourceDefinition (const QString &source=QString(), bool selectedFeaturesOnly=false)
	Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source. More...
	QgsProcessingFeatureSourceDefinition (const QgsProperty &source, bool selectedFeaturesOnly=false)
	Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source. More...
	operator QVariant () const
	Allows direct construction of QVariants. More...
bool	operator!= (const QgsProcessingFeatureSourceDefinition &other)
bool	operator== (const QgsProcessingFeatureSourceDefinition &other)

Public Attributes
bool	selectedFeaturesOnly
	True if only selected features in the source should be used by algorithms. More...
QgsProperty	source
	Source definition. More...

Detailed Description

Encapsulates settings relating to a feature source input to a processing algorithm.

Since

QGIS 3.0

Definition at line 48 of file qgsprocessingparameters.h.

Constructor & Destructor Documentation

QgsProcessingFeatureSourceDefinition() [1/2]

QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition ( const QString &  source = QString(), bool  selectedFeaturesOnly = false  )

inline

Constructor for QgsProcessingFeatureSourceDefinition, accepting a static string source.

Definition at line 55 of file qgsprocessingparameters.h.

QgsProcessingFeatureSourceDefinition() [2/2]

QgsProcessingFeatureSourceDefinition::QgsProcessingFeatureSourceDefinition ( const QgsProperty &  source, bool  selectedFeaturesOnly = false  )

inline

Constructor for QgsProcessingFeatureSourceDefinition, accepting a QgsProperty source.

Definition at line 63 of file qgsprocessingparameters.h.

Member Function Documentation

operator QVariant()

QgsProcessingFeatureSourceDefinition::operator QVariant ( ) const

inline

Allows direct construction of QVariants.

Definition at line 89 of file qgsprocessingparameters.h.

operator!=()

bool QgsProcessingFeatureSourceDefinition::operator!= ( const QgsProcessingFeatureSourceDefinition &  other )

inline

Definition at line 83 of file qgsprocessingparameters.h.

operator==()

bool QgsProcessingFeatureSourceDefinition::operator== ( const QgsProcessingFeatureSourceDefinition &  other )

inline

Definition at line 78 of file qgsprocessingparameters.h.

Member Data Documentation

selectedFeaturesOnly

bool QgsProcessingFeatureSourceDefinition::selectedFeaturesOnly

True if only selected features in the source should be used by algorithms.

Definition at line 76 of file qgsprocessingparameters.h.

source

QgsProperty QgsProcessingFeatureSourceDefinition::source

Source definition.

Usually a static property set to a source layer's ID or file name.

Definition at line 71 of file qgsprocessingparameters.h.

---

The documentation for this class was generated from the following file:

• /tmp/buildd/qgis-3.2.0+99unstable/src/core/processing/qgsprocessingparameters.h