QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsfeatureiterator.h>
Public Member Functions | |
QgsAbstractFeatureIteratorFromSource (T *source, bool ownSource, const QgsFeatureRequest &request) | |
~QgsAbstractFeatureIteratorFromSource () override | |
![]() | |
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... | |
virtual bool | close ()=0 |
end of iterating: free the resources / lock 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 bool | rewind ()=0 |
reset the iterator to the starting position 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 | |
void | iteratorClosed () |
to be called by from subclass in close() More... | |
![]() | |
void | deref () |
Remove reference, delete if refs == 0. More... | |
virtual bool | fetchFeature (QgsFeature &f)=0 |
If you write a feature iterator for your provider, this is the method you need to implement!! 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 | nextFeatureFilterFids (QgsFeature &f) |
By default, the iterator will fetch all features and check if the id is in the request. 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... | |
Protected Attributes | |
bool | mOwnSource |
T * | mSource = nullptr |
![]() | |
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 | 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) TODO QGIS3: make this private More... | |
Additional Inherited Members | |
![]() | |
enum | CompileStatus { NoCompilation, PartiallyCompiled, Compiled } |
Status of expression compilation for filter expression requests. More... | |
Helper template that cares of two things: 1. automatic deletion of source if owned by iterator, 2. notification of open/closed iterator.
Definition at line 233 of file qgsfeatureiterator.h.
|
inline |
Definition at line 236 of file qgsfeatureiterator.h.
|
inlineoverride |
Definition at line 244 of file qgsfeatureiterator.h.
|
inlineprotected |
to be called by from subclass in close()
Definition at line 252 of file qgsfeatureiterator.h.
|
protected |
Definition at line 255 of file qgsfeatureiterator.h.
|
protected |
Definition at line 254 of file qgsfeatureiterator.h.