QGIS API Documentation 3.99.0-Master (21b3aa880ba)
Loading...
Searching...
No Matches
qgsdataprovider.cpp
Go to the documentation of this file.
1/***************************************************************************
2 qgsdataprovider.cpp - DataProvider Interface
3 --------------------------------------
4 Date : May 2016
5 Copyright : (C) 2016 by Matthias Kuhn
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#include "qgsdataprovider.h"
17
19#include "qgsthreadingutils.h"
20
21#include <QMutexLocker>
22
23#include "moc_qgsdataprovider.cpp"
24
25#define SUBLAYER_SEPARATOR QStringLiteral( "!!::!!" )
26
29 : mDataSourceURI( uri ),
30 mOptions( providerOptions )
31{
33}
34
36{
38
39 return QString();
40}
41
48
55
62
69
76
78{
79 return QString();
80}
81
83{
84 return QString();
85}
86
87bool QgsDataProvider::setSubsetString( const QString &subset, bool updateFeatureCount )
88{
89 // NOP by default
90 Q_UNUSED( subset )
91 Q_UNUSED( updateFeatureCount )
92 return false;
93}
94
96{
97 return false;
98}
99
101{
102 return QString();
103}
104
106{
107 // Because QgsVirtualLayerTask is not thread safe:
109
110 reloadProviderData();
111 emit dataChanged();
112}
113
115{
117
118 mProviderProperties.insert( property, value );
119}
120
121void QgsDataProvider::setProviderProperty( int property, const QVariant &value )
122{
124
125 mProviderProperties.insert( property, value );
126}
127
128QVariant QgsDataProvider::providerProperty( QgsDataProvider::ProviderProperty property, const QVariant &defaultValue ) const
129{
131
132 return mProviderProperties.value( property, defaultValue );
133}
134
135QVariant QgsDataProvider::providerProperty( int property, const QVariant &defaultValue = QVariant() ) const
136{
138
139 return mProviderProperties.value( property, defaultValue );
140}
141
142void QgsDataProvider::setListening( bool isListening )
143{
145
146 Q_UNUSED( isListening )
147}
148
155
157{
159
160 const QMutexLocker locker( &mOptionsMutex );
161 return mOptions.transformContext;
162}
163
165{
167
168 const QMutexLocker locker( &mOptionsMutex );
169 mOptions.transformContext = value;
170}
171
176
QFlags< DataProviderFlag > DataProviderFlags
Data provider flags.
Definition qgis.h:2315
QFlags< DataProviderReadFlag > DataProviderReadFlags
Flags which control data provider construction.
Definition qgis.h:486
QFlags< ProviderStyleStorageCapability > ProviderStyleStorageCapabilities
Definition qgis.h:5427
Contains information about the context in which a coordinate transform is executed.
Base class for handling elevation related properties for a data provider.
Base class for handling properties relating to a data provider's temporal capabilities.
virtual QString subsetString() const
Returns the subset definition string currently in use by the layer and used by the provider to limit ...
QgsCoordinateTransformContext transformContext() const
Returns data provider coordinate transform context.
virtual void setListening(bool isListening)
Set whether the provider will listen to datasource notifications If set, the provider will issue noti...
virtual Qgis::DataProviderFlags flags() const
Returns the generic data provider flags.
void setProviderProperty(ProviderProperty property, const QVariant &value)
Allows setting arbitrary properties on the provider.
virtual bool supportsSubsetString() const
Returns true if the provider supports setting of subset strings.
void dataChanged()
Emitted whenever a change is made to the data provider which may have caused changes in the provider'...
virtual QString subsetStringHelpUrl() const
Returns a URL pointing to documentation describing the dialect which is supported for subset strings ...
virtual Qgis::ProviderStyleStorageCapabilities styleStorageCapabilities() const
Returns the style storage capabilities.
ProviderProperty
Properties are used to pass custom configuration options into data providers.
QgsDataProvider(const QString &uri=QString(), const QgsDataProvider::ProviderOptions &providerOptions=QgsDataProvider::ProviderOptions(), Qgis::DataProviderReadFlags flags=Qgis::DataProviderReadFlags())
Create a new dataprovider with the specified in the uri.
virtual QgsDataProviderTemporalCapabilities * temporalCapabilities()
Returns the provider's temporal capabilities.
virtual bool setSubsetString(const QString &subset, bool updateFeatureCount=true)
Set the subset string used to create a subset of features in the layer.
QgsDataSourceUri uri() const
Gets the data source specification.
static QString sublayerSeparator()
String sequence used for separating components of sublayers strings.
QVariant providerProperty(ProviderProperty property, const QVariant &defaultValue=QVariant()) const
Gets the current value of a certain provider property.
virtual QString subsetStringDialect() const
Returns a user-friendly string describing the dialect which is supported for subset strings by the pr...
Qgis::DataProviderReadFlags mReadFlags
Read flags. It's up to the subclass to respect these when needed.
virtual QString htmlMetadata() const
Obtain a formatted HTML string containing assorted metadata for this data provider.
virtual QgsDataProviderElevationProperties * elevationProperties()
Returns the provider's elevation properties.
virtual bool renderInPreview(const QgsDataProvider::PreviewContext &context)
Returns whether the layer must be rendered in preview jobs.
virtual void reloadData()
Reloads the data from the source for providers with data caches to synchronize, changes in the data s...
virtual void setTransformContext(const QgsCoordinateTransformContext &transformContext)
Sets data coordinate transform context to transformContext.
#define SUBLAYER_SEPARATOR
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS_NON_FATAL
#define QGIS_PROTECT_QOBJECT_THREAD_ACCESS
Stores settings related to the context in which a preview job runs.
double maxRenderingTimeMs
Default maximum allowable render time, in ms.
double lastRenderingTimeMs
Previous rendering time for the layer, in ms.
Setting options for creating vector data providers.