QGIS API Documentation 3.99.0-Master (a26b91b364d)
qgsdimensionfilter.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsdimensionfilter.h
3 -------------------
4 begin : September 2021
5 copyright : (C) 2021 Matthias Kuhn
6 email : matthias@opengis.ch
7 ***************************************************************************/
8
9/***************************************************************************
10 * *
11 * This program is free software; you can redistribute it and/or modify *
12 * it under the terms of the GNU General Public License as published by *
13 * the Free Software Foundation; either version 2 of the License, or *
14 * (at your option) any later version. *
15 * *
16 ***************************************************************************/
17
18#ifndef QGSDIMENSIONFILTER_H
19#define QGSDIMENSIONFILTER_H
20
21#define SIP_NO_FILE
22
24#include "qgis_server.h"
25
26#include <QHash>
27
34class SERVER_EXPORT QgsDimensionFilter : public QgsFeatureFilterProvider
35{
36 public:
41 QgsDimensionFilter( const QHash<const QgsVectorLayer *, QStringList> dimensionFilter );
42
43 bool isFilterThreadSafe() const override { return false; }
44
45 void filterFeatures( const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures ) const override;
46 QStringList layerAttributes( const QgsVectorLayer *layer, const QStringList &attributes ) const override;
47 QgsDimensionFilter *clone() const override;
48
49 private:
50 QHash<const QgsVectorLayer *, QStringList> mDimensionFilter;
51};
52
53#endif // QGSDIMENSIONFILTER_H
A server filter to apply a dimension filter to a request.
bool isFilterThreadSafe() const override
Returns true if the filterFeature function is thread safe, which will lead to reliance on layer ID in...
Abstract interface for use by classes that filter the features or attributes of a layer.
virtual QStringList layerAttributes(const QgsVectorLayer *layer, const QStringList &attributes) const =0
Returns the list of visible attribute names from a list of attributes names for the given layer.
virtual Q_DECL_DEPRECATED void filterFeatures(const QgsVectorLayer *layer, QgsFeatureRequest &featureRequest) const
Add additional filters to the feature request to further restrict the features returned by the reques...
virtual QgsFeatureFilterProvider * clone() const =0
Create a clone of the feature filter provider.
Wraps a request for features to a vector layer (or directly its vector data provider).
Represents a vector layer which manages a vector based dataset.