QgsDimensionFilter Class Reference

A server filter to apply a dimension filter to a request. More...

#include <qgsdimensionfilter.h>

Inheritance diagram for QgsDimensionFilter:

Public Member Functions
	QgsDimensionFilter (const QHash< const QgsVectorLayer *, QStringList > dimensionFilter)
	Creates a new dimension filter object with a list of filters to be applied to vector layers.
QgsDimensionFilter *	clone () const override
	Create a clone of the feature filter provider.
void	filterFeatures (const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
	Add additional filters to the feature request to further restrict the features returned by the request.
bool	isFilterThreadSafe () const override
	Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID instead of the raw layer pointer.
QStringList	layerAttributes (const QgsVectorLayer *layer, const QStringList &attributes) const override
	Returns the list of visible attribute names from a list of attributes names for the given layer.
Public Member Functions inherited from QgsFeatureFilterProvider
	QgsFeatureFilterProvider ()=default
virtual	~QgsFeatureFilterProvider ()=default
virtual void	filterFeatures (const QString &layerId, QgsFeatureRequest &featureRequest) const
	Add additional filters to the feature request to further restrict the features returned by the request.

Detailed Description

A server filter to apply a dimension filter to a request.

Since

QGIS 3.22

Definition at line 34 of file qgsdimensionfilter.h.

Constructor & Destructor Documentation

QgsDimensionFilter()

QgsDimensionFilter::QgsDimensionFilter

(

const QHash< const QgsVectorLayer *, QStringList >

dimensionFilter

)

Creates a new dimension filter object with a list of filters to be applied to vector layers.

Definition at line 21 of file qgsdimensionfilter.cpp.

Member Function Documentation

clone()

QgsDimensionFilter * QgsDimensionFilter::clone ( ) const

overridevirtual

Create a clone of the feature filter provider.

Returns

a new clone

Implements QgsFeatureFilterProvider.

Definition at line 40 of file qgsdimensionfilter.cpp.

filterFeatures()

void QgsDimensionFilter::filterFeatures ( const QgsVectorLayer *  layer, QgsFeatureRequest &  featureRequest  ) const

overridevirtual

Add additional filters to the feature request to further restrict the features returned by the request.

Derived classes must implement this method.

Parameters

layer	the layer to filter
featureRequest	the feature request to update

Deprecated:

QGIS 4.0. Use the layer ID variant.

Reimplemented from QgsFeatureFilterProvider.

Definition at line 26 of file qgsdimensionfilter.cpp.

isFilterThreadSafe()

bool QgsDimensionFilter::isFilterThreadSafe ( ) const

inlineoverridevirtual

Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID instead of the raw layer pointer.

Since

QGIS 4.0

Deprecated:

QGIS 4.0

Reimplemented from QgsFeatureFilterProvider.

Definition at line 43 of file qgsdimensionfilter.h.

layerAttributes()

QStringList QgsDimensionFilter::layerAttributes ( const QgsVectorLayer *  layer, const QStringList &  attributes  ) const

overridevirtual

Returns the list of visible attribute names from a list of attributes names for the given layer.

Since

QGIS 3.18

Implements QgsFeatureFilterProvider.

Definition at line 34 of file qgsdimensionfilter.cpp.

---

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

• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/server/qgsdimensionfilter.h
• /build/qgis-3.99.0+git20250718+f78f5286a64+99sid/src/server/qgsdimensionfilter.cpp