QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Delivers features from the cache. More...
#include <qgscachedfeatureiterator.h>
Public Member Functions | |
QgsCachedFeatureIterator (QgsVectorLayerCache *vlCache, const QgsFeatureRequest &featureRequest) | |
This constructor creates a feature iterator, that delivers all cached features. More... | |
~QgsCachedFeatureIterator () override | |
bool | close () override |
Close this iterator. More... | |
bool | rewind () override |
Rewind to the beginning of the iterator. More... | |
![]() | |
QgsAbstractFeatureIterator (const QgsFeatureRequest &request) | |
base class constructor - stores the iteration parameters More... | |
virtual | ~QgsAbstractFeatureIterator ()=default |
destructor makes sure that the iterator is closed properly More... | |
bool | compileFailed () const |
Indicator if there was an error when sending the compiled query to the server. More... | |
CompileStatus | compileStatus () const |
Returns the status of expression compilation for filter expression requests. More... | |
virtual bool | isValid () const |
Returns if this iterator is valid. More... | |
virtual bool | nextFeature (QgsFeature &f) |
fetch next feature, return true on success More... | |
virtual void | setInterruptionChecker (QgsFeedback *interruptionChecker) |
Attach an object that can be queried regularly by the iterator to check if it must stopped. More... | |
Protected Member Functions | |
bool | fetchFeature (QgsFeature &f) override |
Implementation for fetching a feature. More... | |
bool | nextFeatureFilterFids (QgsFeature &f) override |
We have a local special iterator for FilterFids, no need to run the generic. More... | |
![]() | |
void | deref () |
Remove reference, delete if refs == 0. More... | |
QgsRectangle | filterRectToSourceCrs (const QgsCoordinateTransform &transform) const SIP_THROW(QgsCsException) |
Returns a rectangle representing the original request's QgsFeatureRequest::filterRect(). More... | |
void | geometryToDestinationCrs (QgsFeature &feature, const QgsCoordinateTransform &transform) const |
Transforms feature's geometry according to the specified coordinate transform. More... | |
virtual bool | nextFeatureFilterExpression (QgsFeature &f) |
By default, the iterator will fetch all features and check if the feature matches the expression. More... | |
virtual bool | prepareSimplification (const QgsSimplifyMethod &simplifyMethod) |
Setup the simplification of geometries to fetch using the specified simplify method. More... | |
void | ref () |
Add reference. More... | |
RequestToSourceCrsResult | updateRequestToSourceCrs (QgsFeatureRequest &request, const QgsCoordinateTransform &transform) const SIP_THROW(QgsCsException) |
Update a QgsFeatureRequest so that spatial filters are transformed to the source's coordinate reference system. More... | |
Additional Inherited Members | |
![]() | |
enum | CompileStatus { NoCompilation, PartiallyCompiled, Compiled } |
Status of expression compilation for filter expression requests. More... | |
enum | RequestToSourceCrsResult : int { RequestToSourceCrsResult::Success, RequestToSourceCrsResult::DistanceWithinMustBeCheckedManually } |
Possible results from the updateRequestToSourceCrs() method. More... | |
![]() | |
bool | mClosed = false |
Sets to true , as soon as the iterator is closed. More... | |
bool | mCompileFailed = false |
CompileStatus | mCompileStatus = NoCompilation |
Status of compilation of filter expression. More... | |
long long | mFetchedCount = 0 |
Number of features already fetched by iterator. More... | |
QgsFeatureRequest | mRequest |
A copy of the feature request. More... | |
bool | mValid = true |
An invalid state of a feature iterator indicates that there was a problem with even getting it up and running. More... | |
bool | mZombie = false |
A feature iterator may be closed already but still be serving features from the cache. More... | |
int | refs = 0 |
reference counting (to allow seamless copying of QgsFeatureIterator instances) More... | |
Delivers features from the cache.
Definition at line 32 of file qgscachedfeatureiterator.h.
QgsCachedFeatureIterator::QgsCachedFeatureIterator | ( | QgsVectorLayerCache * | vlCache, |
const QgsFeatureRequest & | featureRequest | ||
) |
This constructor creates a feature iterator, that delivers all cached features.
No request is made to the backend.
vlCache | The vector layer cache to use |
featureRequest | The feature request to answer |
Definition at line 22 of file qgscachedfeatureiterator.cpp.
|
overridedefault |
|
overridevirtual |
Close this iterator.
No further features will be available.
true
if successful Implements QgsAbstractFeatureIterator.
Definition at line 138 of file qgscachedfeatureiterator.cpp.
|
overrideprotectedvirtual |
Implementation for fetching a feature.
f | Will write to this feature |
true
if the operation was OKImplements QgsAbstractFeatureIterator.
Definition at line 95 of file qgscachedfeatureiterator.cpp.
|
inlineoverrideprotectedvirtual |
We have a local special iterator for FilterFids, no need to run the generic.
f | Will write to this feature |
true
if the operation was OK Reimplemented from QgsAbstractFeatureIterator.
Definition at line 79 of file qgscachedfeatureiterator.h.
|
overridevirtual |
Rewind to the beginning of the iterator.
true
if the operation was OK Implements QgsAbstractFeatureIterator.
Definition at line 132 of file qgscachedfeatureiterator.cpp.