QgsCachedFeatureIterator class

Delivers features from the cache.

Base classes

class QgsAbstractFeatureIterator
Internal feature iterator to be implemented within data providers.

Constructors, destructors, conversion operators

QgsCachedFeatureIterator(QgsVectorLayerCache* vlCache, const QgsFeatureRequest& featureRequest)
This constructor creates a feature iterator, that delivers all cached features.

Public functions

auto close() -> bool override
Close this iterator.
auto rewind() -> bool override
Rewind to the beginning of the iterator.

Protected functions

auto fetchFeature(QgsFeature& f) -> bool override
Implementation for fetching a feature.
auto nextFeatureFilterFids(QgsFeature& f) -> bool override
We have a local special iterator for FilterFids, no need to run the generic.

Function documentation

QgsCachedFeatureIterator::QgsCachedFeatureIterator(QgsVectorLayerCache* vlCache, const QgsFeatureRequest& featureRequest)

This constructor creates a feature iterator, that delivers all cached features.

Parameters
vlCache The vector layer cache to use
featureRequest The feature request to answer

No request is made to the backend.

bool QgsCachedFeatureIterator::close() override

Close this iterator.

Returns true if successful

No further features will be available.

bool QgsCachedFeatureIterator::rewind() override

Rewind to the beginning of the iterator.

Returns bool true if the operation was OK

bool QgsCachedFeatureIterator::fetchFeature(QgsFeature& f) override protected

Implementation for fetching a feature.

Parameters
f Will write to this feature
Returns bool true if the operation was OK

bool QgsCachedFeatureIterator::nextFeatureFilterFids(QgsFeature& f) override protected

We have a local special iterator for FilterFids, no need to run the generic.

Parameters
f Will write to this feature
Returns bool true if the operation was OK