mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
73 lines
2.9 KiB
Plaintext
73 lines
2.9 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgscacheindex.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsAbstractCacheIndex
|
|
{
|
|
%Docstring(signature="appended")
|
|
Abstract base class for cache indices
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgscacheindex.h"
|
|
%End
|
|
public:
|
|
|
|
QgsAbstractCacheIndex();
|
|
virtual ~QgsAbstractCacheIndex();
|
|
|
|
virtual void flushFeature( QgsFeatureId fid ) = 0;
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
virtual void flush() = 0;
|
|
%Docstring
|
|
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.
|
|
%End
|
|
|
|
virtual void requestCompleted( const QgsFeatureRequest &featureRequest, const QgsFeatureIds &fids );
|
|
%Docstring
|
|
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
|
|
|
|
:param featureRequest: The feature request that was answered
|
|
:param fids: The feature ids that have been returned
|
|
%End
|
|
|
|
virtual bool getCacheIterator( QgsFeatureIterator &featureIterator, const QgsFeatureRequest &featureRequest ) = 0;
|
|
%Docstring
|
|
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``.
|
|
|
|
:param featureIterator: A reference to a :py:class:`QgsFeatureIterator`. A valid featureIterator will
|
|
be assigned in case this index is able to answer the request and the return
|
|
value is ``True``.
|
|
:param featureRequest: The feature request, for which this index is queried.
|
|
|
|
:return: ``True``, if this index holds the information to answer the request.
|
|
%End
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgscacheindex.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|