Holds metadata about mesh driver. More...

#include <qgsprovidermetadata.h>

Public Types
enum	MeshDriverCapability { CanWriteFaceDatasets = 1 << 0, CanWriteVertexDatasets = 1 << 1, CanWriteEdgeDatasets = 1 << 2, CanWriteMeshData = 1 << 3 }
	Flags for the capabilities of the driver. More...

Public Member Functions
	QgsMeshDriverMetadata ()
	Constructs default metadata without any capabilities. More...

	QgsMeshDriverMetadata (const QString &name, const QString &description, const MeshDriverCapabilities &capabilities, const QString &writeDatasetOnFileSuffix)
	Constructs driver metadata with selected capabilities. More...

MeshDriverCapabilities	capabilities () const
	Returns the capabilities for this driver. More...

QString	description () const
	Returns the description for this driver. More...

QString	name () const
	Returns the name (key) for this driver. More...

QString	writeDatasetOnFileSuffix () const
	Returns the suffix used to write datasets on file. More...

Detailed Description

Holds metadata about mesh driver.

Since: QGIS 3.12

Definition at line 54 of file qgsprovidermetadata.h.

Member Enumeration Documentation

◆ MeshDriverCapability

enum QgsMeshDriverMetadata::MeshDriverCapability

Flags for the capabilities of the driver.

Enumerator
CanWriteFaceDatasets	If the driver can persist datasets defined on faces.
CanWriteVertexDatasets	If the driver can persist datasets defined on vertices.
CanWriteEdgeDatasets	If the driver can persist datasets defined on edges. Since QGIS 3.14
CanWriteMeshData	If the driver can write mesh data on file. Since QGIS 3.16

Definition at line 63 of file qgsprovidermetadata.h.

Constructor & Destructor Documentation

◆ QgsMeshDriverMetadata() [1/2]

QgsMeshDriverMetadata::QgsMeshDriverMetadata ( )

default

Constructs default metadata without any capabilities.

◆ QgsMeshDriverMetadata() [2/2]

QgsMeshDriverMetadata::QgsMeshDriverMetadata	(	const QString &	name,
		const QString &	description,
		const MeshDriverCapabilities &	capabilities,
		const QString &	writeDatasetOnFileSuffix
	)

Constructs driver metadata with selected capabilities.

Parameters

name	name/key of the driver
description	short description of the driver
capabilities	driver's capabilities

Definition at line 305 of file qgsprovidermetadata.cpp.

Member Function Documentation

◆ capabilities()

QgsMeshDriverMetadata::MeshDriverCapabilities QgsMeshDriverMetadata::capabilities ( ) const

Returns the capabilities for this driver.

Definition at line 310 of file qgsprovidermetadata.cpp.

◆ description()

QString QgsMeshDriverMetadata::description ( ) const

Returns the description for this driver.

Definition at line 320 of file qgsprovidermetadata.cpp.

◆ name()

QString QgsMeshDriverMetadata::name ( ) const

Returns the name (key) for this driver.

Definition at line 315 of file qgsprovidermetadata.cpp.

◆ writeDatasetOnFileSuffix()

QString QgsMeshDriverMetadata::writeDatasetOnFileSuffix ( ) const

Returns the suffix used to write datasets on file.

Definition at line 325 of file qgsprovidermetadata.cpp.

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

/build/qgis-3.16.0+99unstable/src/core/qgsprovidermetadata.h
/build/qgis-3.16.0+99unstable/src/core/qgsprovidermetadata.cpp

Public Types

Public Member Functions