QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsfeaturepool.h>
Public Member Functions | |
QgsFeaturePool (QgsVectorLayer *layer) | |
Creates a new feature pool for layer. More... | |
virtual | ~QgsFeaturePool ()=default |
QgsFeatureIds | allFeatureIds () const |
Returns the complete set of feature ids in this pool. More... | |
QgsCoordinateReferenceSystem | crs () const |
The coordinate reference system of this layer. More... | |
virtual void | deleteFeature (QgsFeatureId fid)=0 |
Removes a feature from this pool. More... | |
QgsWkbTypes::GeometryType | geometryType () const |
The geometry type of this layer. More... | |
bool | getFeature (QgsFeatureId id, QgsFeature &feature) |
Retrieves the feature with the specified id into feature. More... | |
QgsFeatureIds | getFeatures (const QgsFeatureRequest &request, QgsFeedback *feedback=nullptr) |
Gets features for the provided request. More... | |
QgsFeatureIds | getIntersects (const QgsRectangle &rect) const |
Gets all feature ids in the bounding box rect. More... | |
QgsVectorLayer * | layer () const |
Gets a pointer to the underlying layer. More... | |
QString | layerId () const |
The layer id of the layer. More... | |
QString | layerName () const |
Returns the name of the layer. More... | |
QPointer< QgsVectorLayer > | layerPtr () const |
Gets a QPointer to the underlying layer. More... | |
virtual void | updateFeature (QgsFeature &feature)=0 |
Updates a feature in this pool. More... | |
Public Member Functions inherited from QgsFeatureSink | |
virtual | ~QgsFeatureSink ()=default |
virtual bool | addFeature (QgsFeature &feature, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) |
Adds a single feature to the sink. More... | |
virtual bool | addFeatures (QgsFeatureIterator &iterator, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags()) |
Adds all features from the specified iterator to the sink. More... | |
virtual bool | addFeatures (QgsFeatureList &features, QgsFeatureSink::Flags flags=QgsFeatureSink::Flags())=0 |
Adds a list of features to the sink. More... | |
virtual bool | flushBuffer () |
Flushes any internal buffer which may exist in the sink, causing any buffered features to be added to the sink's destination. More... | |
Protected Member Functions | |
void | insertFeature (const QgsFeature &feature, bool skipLock=false) |
Inserts a feature into the cache and the spatial index. More... | |
bool | isFeatureCached (QgsFeatureId fid) |
Checks if the feature fid is cached. More... | |
void | refreshCache (const QgsFeature &feature) |
Changes a feature in the cache and the spatial index. More... | |
void | removeFeature (const QgsFeatureId featureId) |
Removes a feature from the cache and the spatial index. More... | |
void | setFeatureIds (const QgsFeatureIds &ids) |
Sets all the feature ids governed by this feature pool. More... | |
Additional Inherited Members | |
Public Types inherited from QgsFeatureSink | |
enum | Flag { FastInsert = 1 << 1 } |
Flags controlling how features are added to a sink. More... | |
enum | SinkFlag { RegeneratePrimaryKey = 1 << 1 } |
Flags that can be set on a QgsFeatureSink. More... | |
A feature pool is based on a vector layer and caches features.
Definition at line 37 of file qgsfeaturepool.h.
QgsFeaturePool::QgsFeaturePool | ( | QgsVectorLayer * | layer | ) |
Creates a new feature pool for layer.
Definition at line 29 of file qgsfeaturepool.cpp.
|
virtualdefault |
QgsFeatureIds QgsFeaturePool::allFeatureIds | ( | ) | const |
Returns the complete set of feature ids in this pool.
Note that this concerns the features governed by this pool, which are not necessarily all cached.
Definition at line 95 of file qgsfeaturepool.cpp.
QgsCoordinateReferenceSystem QgsFeaturePool::crs | ( | ) | const |
The coordinate reference system of this layer.
Definition at line 169 of file qgsfeaturepool.cpp.
|
pure virtual |
Removes a feature from this pool.
Implementations will remove the feature from the layer or from the data provider.
Implemented in QgsVectorLayerFeaturePool, and QgsVectorDataProviderFeaturePool.
QgsWkbTypes::GeometryType QgsFeaturePool::geometryType | ( | ) | const |
The geometry type of this layer.
Definition at line 175 of file qgsfeaturepool.cpp.
bool QgsFeaturePool::getFeature | ( | QgsFeatureId | id, |
QgsFeature & | feature | ||
) |
Retrieves the feature with the specified id into feature.
It will be retrieved from the cache or from the underlying feature source if unavailable. If the feature is neither available from the cache nor from the source it will return false
.
Definition at line 39 of file qgsfeaturepool.cpp.
QgsFeatureIds QgsFeaturePool::getFeatures | ( | const QgsFeatureRequest & | request, |
QgsFeedback * | feedback = nullptr |
||
) |
Gets features for the provided request.
No features will be fetched from the cache and the request is sent directly to the underlying feature source. Results of the request are cached in the pool and the ids of all the features are returned. This is used to warm the cache for a particular area of interest (bounding box) or other set of features. This will get a new feature source from the source vector layer. This needs to be called from the main thread. If feedback is specified, the call may return if the feedback is canceled.
Definition at line 71 of file qgsfeaturepool.cpp.
QgsFeatureIds QgsFeaturePool::getIntersects | ( | const QgsRectangle & | rect | ) | const |
Gets all feature ids in the bounding box rect.
It will use a spatial index to determine the ids.
Definition at line 100 of file qgsfeaturepool.cpp.
|
protected |
Inserts a feature into the cache and the spatial index.
To be used by implementations of addFeature
.
Definition at line 119 of file qgsfeaturepool.cpp.
|
protected |
Checks if the feature fid is cached.
Definition at line 158 of file qgsfeaturepool.cpp.
QgsVectorLayer * QgsFeaturePool::layer | ( | ) | const |
Gets a pointer to the underlying layer.
May return a \c nullptr
if the layer has been deleted. This must only be called from the main thread.
Definition at line 107 of file qgsfeaturepool.cpp.
QString QgsFeaturePool::layerId | ( | ) | const |
The layer id of the layer.
Definition at line 180 of file qgsfeaturepool.cpp.
QString QgsFeaturePool::layerName | ( | ) | const |
Returns the name of the layer.
Should be preferred over layer().name() because it can directly be run on the background thread.
Definition at line 164 of file qgsfeaturepool.cpp.
QPointer< QgsVectorLayer > QgsFeaturePool::layerPtr | ( | ) | const |
Gets a QPointer to the underlying layer.
Note that access to any methods of the object will need to be done on the main thread and the pointer will need to be checked for validity before usage.
Definition at line 114 of file qgsfeaturepool.cpp.
|
protected |
Changes a feature in the cache and the spatial index.
To be used by implementations of updateFeature
.
Definition at line 129 of file qgsfeaturepool.cpp.
|
protected |
Removes a feature from the cache and the spatial index.
To be used by implementations of deleteFeature
.
Definition at line 140 of file qgsfeaturepool.cpp.
|
protected |
Sets all the feature ids governed by this feature pool.
Should be called by subclasses constructor and whenever they insert a new feature.
Definition at line 153 of file qgsfeaturepool.cpp.
|
pure virtual |
Updates a feature in this pool.
Implementations will update the feature on the layer or on the data provider.
Implemented in QgsVectorLayerFeaturePool, and QgsVectorDataProviderFeaturePool.