QGIS API Documentation  3.16.0-Hannover (43b64b13f3)
Public Member Functions | List of all members
QgsCacheIndexFeatureId Class Reference

#include <qgscacheindexfeatureid.h>

Inheritance diagram for QgsCacheIndexFeatureId:
Inheritance graph
[legend]

Public Member Functions

 QgsCacheIndexFeatureId (QgsVectorLayerCache *)
 
void flush () override
 Sometimes, the whole cache changes its state and its easier to just withdraw everything. More...
 
void flushFeature (QgsFeatureId fid) override
 Is called whenever a feature is removed from the cache. More...
 
bool getCacheIterator (QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest) override
 Is called when a feature request is issued on a cached layer. More...
 
void requestCompleted (const QgsFeatureRequest &featureRequest, const QgsFeatureIds &fids) override
 Implement this method to update the the indices, in case you need information contained by the request to properly index. More...
 
- Public Member Functions inherited from QgsAbstractCacheIndex
 QgsAbstractCacheIndex ()=default
 Constructor for QgsAbstractCacheIndex. More...
 
virtual ~QgsAbstractCacheIndex ()=default
 

Detailed Description

Definition at line 28 of file qgscacheindexfeatureid.h.

Constructor & Destructor Documentation

◆ QgsCacheIndexFeatureId()

QgsCacheIndexFeatureId::QgsCacheIndexFeatureId ( QgsVectorLayerCache cachedVectorLayer)

Definition at line 21 of file qgscacheindexfeatureid.cpp.

Member Function Documentation

◆ flush()

void QgsCacheIndexFeatureId::flush ( )
overridevirtual

Sometimes, the whole cache changes its state and its easier to just withdraw everything.

In this case, this method is issued. Be sure to clear all cache information in here.

Implements QgsAbstractCacheIndex.

Definition at line 32 of file qgscacheindexfeatureid.cpp.

◆ flushFeature()

void QgsCacheIndexFeatureId::flushFeature ( QgsFeatureId  fid)
overridevirtual

Is called whenever a feature is removed from the cache.

You should update your indexes so they become invalid in case this feature was required to successfully answer a request.

Implements QgsAbstractCacheIndex.

Definition at line 27 of file qgscacheindexfeatureid.cpp.

◆ getCacheIterator()

bool QgsCacheIndexFeatureId::getCacheIterator ( QgsFeatureIterator featureIterator,
const QgsFeatureRequest featureRequest 
)
overridevirtual

Is called when a feature request is issued on a cached layer.

If this cache index is able to completely answer the feature request, it will return true and set the iterator to a valid iterator over the cached features. If it is not able it will return false.

Parameters
featureIteratorA reference to a QgsFeatureIterator. A valid featureIterator will be assigned in case this index is able to answer the request and the return value is true.
featureRequestThe feature request, for which this index is queried.
Returns
true, if this index holds the information to answer the request.

Implements QgsAbstractCacheIndex.

Definition at line 42 of file qgscacheindexfeatureid.cpp.

◆ requestCompleted()

void QgsCacheIndexFeatureId::requestCompleted ( const QgsFeatureRequest featureRequest,
const QgsFeatureIds fids 
)
overridevirtual

Implement this method to update the the indices, in case you need information contained by the request to properly index.

(E.g. spatial index) Does nothing by default

Parameters
featureRequestThe feature request that was answered
fidsThe feature ids that have been returned

Reimplemented from QgsAbstractCacheIndex.

Definition at line 36 of file qgscacheindexfeatureid.cpp.


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