Base class for providing data for QgsMeshLayer. More...
#include <qgsmeshdataprovider.h>
Inheritance diagram for QgsMeshDataProvider:
Signals | |
| void | datasetGroupsAdded (int count) |
| Emitted when some new dataset groups have been added. More... | |
 Signals inherited from QgsDataProvider | |
| void | dataChanged () |
| Emitted whenever a change is made to the data provider which may have caused changes in the provider's data OUTSIDE of QGIS. More... | |
| void | fullExtentCalculated () |
| Emitted whenever a deferred extent calculation is completed by the provider. More... | |
| void | notify (const QString &msg) |
| Emitted when the datasource issues a notification. More... | |
Public Member Functions | |
| QgsMeshDataProvider (const QString &uri, const QgsDataProvider::ProviderOptions &options) | |
| Ctor. More... | |
| Public Member Functions inherited from QgsDataProvider | |
| QgsDataProvider (const QString &uri=QString(), const QgsDataProvider::ProviderOptions &options=QgsDataProvider::ProviderOptions()) | |
| Create a new dataprovider with the specified in the uri. More... | |
| virtual QgsCoordinateReferenceSystem | crs () const =0 |
| Returns the coordinate system for the data source. More... | |
| virtual QString | dataSourceUri (bool expandAuthConfig=false) const |
| Gets the data source specification. More... | |
| virtual QDateTime | dataTimestamp () const |
| Current time stamp of data source. More... | |
| virtual QString | description () const =0 |
| Returns description. More... | |
| virtual bool | enterUpdateMode () |
| Enter update mode. More... | |
| virtual QgsError | error () const |
| Gets current status error. More... | |
| virtual QgsRectangle | extent () const =0 |
| Returns the extent of the layer. More... | |
| virtual QString | fileRasterFilters () const |
| Returns raster file filter string. More... | |
| virtual QString | fileVectorFilters () const |
| Returns vector file filter string. More... | |
| virtual void | invalidateConnections (const QString &connection) |
| Invalidate connections corresponding to specified name. More... | |
| virtual bool | isValid () const =0 |
| Returns true if this is a valid layer. More... | |
| virtual QgsLayerMetadata | layerMetadata () const |
| Returns layer metadata collected from the provider's source. More... | |
| virtual bool | leaveUpdateMode () |
| Leave update mode. More... | |
| virtual QString | name () const =0 |
| Returns a provider name. More... | |
| QVariant | providerProperty (ProviderProperty property, const QVariant &defaultValue=QVariant()) const |
| Gets the current value of a certain provider property. More... | |
| QVariant | providerProperty (int property, const QVariant &defaultValue) const |
| Gets the current value of a certain provider property. More... | |
| virtual void | reloadData () |
| Reloads the data from the source. More... | |
| virtual bool | renderInPreview (const QgsDataProvider::PreviewContext &context) |
| Returns whether the layer must be rendered in preview jobs. More... | |
| virtual void | setDataSourceUri (const QString &uri) |
| Set the data source specification. More... | |
| virtual void | setLayerOrder (const QStringList &layers) |
| Reorder the list of layer names to be rendered by this provider (in order from bottom to top) More... | |
| virtual void | setListening (bool isListening) |
| Set whether the provider will listen to datasource notifications If set, the provider will issue notify signals. More... | |
| void | setProviderProperty (ProviderProperty property, const QVariant &value) |
| Allows setting arbitrary properties on the provider. More... | |
| void | setProviderProperty (int property, const QVariant &value) |
| Allows setting arbitrary properties on the provider. More... | |
| virtual void | setSubLayerVisibility (const QString &name, bool vis) |
| Set the visibility of the given sublayer name. More... | |
| virtual bool | setSubsetString (const QString &subset, bool updateFeatureCount=true) |
| Set the subset string used to create a subset of features in the layer. More... | |
| void | setUri (const QgsDataSourceUri &uri) |
| Set the data source specification. More... | |
| virtual uint | subLayerCount () const |
| Returns the number of layers for the current data source. More... | |
| virtual QStringList | subLayers () const |
| Sub-layers handled by this provider, in order from bottom to top. More... | |
| virtual QStringList | subLayerStyles () const |
| Sub-layer styles for each sub-layer handled by this provider, in order from bottom to top. More... | |
| virtual QString | subsetString () const |
| Returns the subset definition string (typically sql) currently in use by the layer and used by the provider to limit the feature set. More... | |
| virtual bool | supportsSubsetString () const |
| Returns true if the provider supports setting of subset strings. More... | |
| virtual QDateTime | timestamp () const |
| Time stamp of data source in the moment when data/metadata were loaded by provider. More... | |
| virtual void | updateExtents () |
| Update the extents of the layer. More... | |
| QgsDataSourceUri | uri () const |
| Gets the data source specification. More... | |
| virtual bool | writeLayerMetadata (const QgsLayerMetadata &metadata) |
| Writes layer metadata to the underlying provider source. More... | |
| Public Member Functions inherited from QgsMeshDataSourceInterface | |
| virtual | ~QgsMeshDataSourceInterface ()=default |
| Dtor. More... | |
| virtual int | faceCount () const =0 |
| Returns number of faces in the native mesh. More... | |
| virtual void | populateMesh (QgsMesh *mesh) const =0 |
| Populates the mesh vertices and faces. More... | |
| virtual int | vertexCount () const =0 |
| Returns number of vertices in the native mesh. More... | |
| Public Member Functions inherited from QgsMeshDatasetSourceInterface | |
| virtual | ~QgsMeshDatasetSourceInterface ()=default |
| Dtor. More... | |
| virtual bool | addDataset (const QString &uri)=0 |
| Associate dataset with the mesh. More... | |
| virtual QgsMeshDataBlock | areFacesActive (QgsMeshDatasetIndex index, int faceIndex, int count) const =0 |
| Returns whether the faces are active for particular dataset. More... | |
| virtual int | datasetCount (int groupIndex) const =0 |
| Returns number of datasets loaded in the group. More... | |
| int | datasetCount (QgsMeshDatasetIndex index) const |
| Returns number of datasets loaded in the group. More... | |
| virtual int | datasetGroupCount () const =0 |
| Returns number of datasets groups loaded. More... | |
| virtual QgsMeshDatasetGroupMetadata | datasetGroupMetadata (int groupIndex) const =0 |
| Returns dataset group metadata. More... | |
| QgsMeshDatasetGroupMetadata | datasetGroupMetadata (QgsMeshDatasetIndex index) const |
| Returns dataset group metadata. More... | |
| virtual QgsMeshDatasetMetadata | datasetMetadata (QgsMeshDatasetIndex index) const =0 |
| Returns dataset metadata. More... | |
| virtual QgsMeshDatasetValue | datasetValue (QgsMeshDatasetIndex index, int valueIndex) const =0 |
| Returns vector/scalar value associated with the index from the dataset To read multiple continuous values, use QgsMeshDatasetSourceInterface::datasetValues() More... | |
| virtual QgsMeshDataBlock | datasetValues (QgsMeshDatasetIndex index, int valueIndex, int count) const =0 |
| Returns N vector/scalar values from the index from the dataset. More... | |
| virtual QStringList | extraDatasets () const =0 |
| Returns list of additional dataset file URIs added using addDataset() calls. More... | |
| virtual bool | isFaceActive (QgsMeshDatasetIndex index, int faceIndex) const =0 |
| Returns whether the face is active for particular dataset. More... | |
| virtual bool | persistDatasetGroup (const QString &path, const QgsMeshDatasetGroupMetadata &meta, const QVector< QgsMeshDataBlock > &datasetValues, const QVector< QgsMeshDataBlock > &datasetActive, const QVector< double > ×)=0 |
| Creates a new dataset group from a data and persists it into a destination path. More... | |
Additional Inherited Members | |
| Public Types inherited from QgsDataProvider | |
| enum | DataCapability { NoDataCapabilities = 0, File = 1, Dir = 1 << 1, Database = 1 << 2, Net = 1 << 3 } |
| enum | ProviderProperty { EvaluateDefaultValues, CustomData = 3000 } |
| Properties are used to pass custom configuration options into data providers. More... | |
| Static Public Attributes inherited from QgsDataProvider | |
| static QString | SUBLAYER_SEPARATOR = QString( "!!::!!" ) |
| String sequence used for separating components of sublayers strings. More... | |
| Protected Member Functions inherited from QgsDataProvider | |
| void | appendError (const QgsErrorMessage &message) |
| Add error message. More... | |
| void | setError (const QgsError &error) |
| Sets error message. More... | |
| Protected Attributes inherited from QgsDataProvider | |
| QgsError | mError |
| Error. More... | |
| QDateTime | mTimestamp |
| Timestamp of data in the moment when the data were loaded by provider. More... | |
Detailed Description
Base class for providing data for QgsMeshLayer.
Responsible for reading native mesh data
- Note
- The API is considered EXPERIMENTAL and can be changed without a notice
- Since
- QGIS 3.2
Definition at line 548 of file qgsmeshdataprovider.h.
Constructor & Destructor Documentation
◆ QgsMeshDataProvider()
| QgsMeshDataProvider::QgsMeshDataProvider | ( | const QString & | uri, |
| const QgsDataProvider::ProviderOptions & | options | ||
| ) |
Ctor.
Definition at line 56 of file qgsmeshdataprovider.cpp.
Member Function Documentation
◆ datasetGroupsAdded
|
signal |
Emitted when some new dataset groups have been added.
The documentation for this class was generated from the following files:
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/mesh/qgsmeshdataprovider.h
- /tmp/buildd/qgis-3.6.0+99unstable/src/core/mesh/qgsmeshdataprovider.cpp
