QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
QgsFeatureSource subclass for the selected features from a QgsVectorLayer. More...
#include <qgsvectorlayerfeatureiterator.h>
Public Member Functions | |
QgsVectorLayerSelectedFeatureSource (const QgsVectorLayerSelectedFeatureSource &other)=delete | |
QgsVectorLayerSelectedFeatureSource cannot be copied. More... | |
QgsVectorLayerSelectedFeatureSource (QgsVectorLayer *layer) | |
Constructor for QgsVectorLayerSelectedFeatureSource, for selected features from the specified layer. More... | |
QgsExpressionContextScope * | createExpressionContextScope () const override |
This method needs to be reimplemented in all classes which implement this interface and return an expression context scope. More... | |
long long | featureCount () const override |
Returns the number of features contained in the source, or -1 if the feature count is unknown. More... | |
QgsFields | fields () const override |
Returns the fields associated with features in the source. More... | |
QgsFeatureIterator | getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest()) const override |
Returns an iterator for the features in the source. More... | |
SpatialIndexPresence | hasSpatialIndex () const override |
Returns an enum value representing the presence of a valid spatial index on the source, if it can be determined. More... | |
QgsVectorLayerSelectedFeatureSource & | operator== (const QgsVectorLayerSelectedFeatureSource &other)=delete |
QgsVectorLayerSelectedFeatureSource cannot be copied. More... | |
QgsCoordinateReferenceSystem | sourceCrs () const override |
Returns the coordinate reference system for features in the source. More... | |
QString | sourceName () const override |
Returns a friendly display name for the source. More... | |
Qgis::WkbType | wkbType () const override |
Returns the geometry type for features returned by this source. More... | |
Public Member Functions inherited from QgsFeatureSource | |
virtual | ~QgsFeatureSource ()=default |
virtual QgsFeatureIds | allFeatureIds () const |
Returns a list of all feature IDs for features present in the source. More... | |
virtual long long | featureCount () const =0 |
Returns the number of features contained in the source, or -1 if the feature count is unknown. More... | |
virtual QgsFields | fields () const =0 |
Returns the fields associated with features in the source. More... | |
virtual QgsFeatureIterator | getFeatures (const QgsFeatureRequest &request=QgsFeatureRequest()) const =0 |
Returns an iterator for the features in the source. More... | |
virtual FeatureAvailability | hasFeatures () const |
Determines if there are any features available in the source. More... | |
virtual SpatialIndexPresence | hasSpatialIndex () const |
Returns an enum value representing the presence of a valid spatial index on the source, if it can be determined. More... | |
QgsVectorLayer * | materialize (const QgsFeatureRequest &request, QgsFeedback *feedback=nullptr) |
Materializes a request (query) made against this feature source, by running it over the source and returning a new memory based vector layer containing the result. More... | |
virtual QVariant | maximumValue (int fieldIndex) const |
Returns the maximum value for an attribute column or an invalid variant in case of error. More... | |
virtual QVariant | minimumValue (int fieldIndex) const |
Returns the minimum value for an attribute column or an invalid variant in case of error. More... | |
virtual QgsCoordinateReferenceSystem | sourceCrs () const =0 |
Returns the coordinate reference system for features in the source. More... | |
virtual QgsRectangle | sourceExtent () const |
Returns the extent of all geometries from the source. More... | |
virtual QString | sourceName () const =0 |
Returns a friendly display name for the source. More... | |
virtual QSet< QVariant > | uniqueValues (int fieldIndex, int limit=-1) const |
Returns the set of unique values contained within the specified fieldIndex from this source. More... | |
virtual Qgis::WkbType | wkbType () const =0 |
Returns the geometry type for features returned by this source. More... | |
Public Member Functions inherited from QgsExpressionContextScopeGenerator | |
virtual | ~QgsExpressionContextScopeGenerator ()=default |
virtual QgsExpressionContextScope * | createExpressionContextScope () const =0 |
This method needs to be reimplemented in all classes which implement this interface and return an expression context scope. More... | |
Additional Inherited Members | |
Public Types inherited from QgsFeatureSource | |
enum | FeatureAvailability { NoFeaturesAvailable , FeaturesAvailable , FeaturesMaybeAvailable } |
Possible return value for hasFeatures() to determine if a source is empty. More... | |
enum | SpatialIndexPresence { SpatialIndexUnknown = 0 , SpatialIndexNotPresent = 1 , SpatialIndexPresent = 2 } |
Enumeration of spatial index presence states. More... | |
QgsFeatureSource subclass for the selected features from a QgsVectorLayer.
Definition at line 374 of file qgsvectorlayerfeatureiterator.h.
QgsVectorLayerSelectedFeatureSource::QgsVectorLayerSelectedFeatureSource | ( | QgsVectorLayer * | layer | ) |
Constructor for QgsVectorLayerSelectedFeatureSource, for selected features from the specified layer.
The currently selected feature IDs are stored, so change to the layer selection after constructing the QgsVectorLayerSelectedFeatureSource will not be reflected.
Definition at line 1358 of file qgsvectorlayerfeatureiterator.cpp.
|
delete |
QgsVectorLayerSelectedFeatureSource cannot be copied.
|
overridevirtual |
This method needs to be reimplemented in all classes which implement this interface and return an expression context scope.
Implements QgsExpressionContextScopeGenerator.
Definition at line 1415 of file qgsvectorlayerfeatureiterator.cpp.
|
overridevirtual |
Returns the number of features contained in the source, or -1 if the feature count is unknown.
Implements QgsFeatureSource.
Definition at line 1405 of file qgsvectorlayerfeatureiterator.cpp.
|
overridevirtual |
Returns the fields associated with features in the source.
Implements QgsFeatureSource.
Definition at line 1395 of file qgsvectorlayerfeatureiterator.cpp.
|
overridevirtual |
Returns an iterator for the features in the source.
An optional request can be used to optimise the returned iterator, eg by restricting the returned attributes or geometry.
Implements QgsFeatureSource.
Definition at line 1366 of file qgsvectorlayerfeatureiterator.cpp.
|
overridevirtual |
Returns an enum value representing the presence of a valid spatial index on the source, if it can be determined.
If QgsFeatureSource::SpatialIndexUnknown is returned then the presence of an index cannot be determined.
Reimplemented from QgsFeatureSource.
Definition at line 1423 of file qgsvectorlayerfeatureiterator.cpp.
|
delete |
QgsVectorLayerSelectedFeatureSource cannot be copied.
|
overridevirtual |
Returns the coordinate reference system for features in the source.
Implements QgsFeatureSource.
Definition at line 1390 of file qgsvectorlayerfeatureiterator.cpp.
|
overridevirtual |
Returns a friendly display name for the source.
The returned value can be an empty string.
Implements QgsFeatureSource.
Definition at line 1410 of file qgsvectorlayerfeatureiterator.cpp.
|
overridevirtual |
Returns the geometry type for features returned by this source.
Implements QgsFeatureSource.
Definition at line 1400 of file qgsvectorlayerfeatureiterator.cpp.