QGIS API Documentation  3.13.0-Master (7f54853aae)
Public Types | Public Member Functions | List of all members
QgsMeshDriverMetadata Class Reference

Holds metadata about mesh driver. More...

#include <qgsprovidermetadata.h>

Public Types

enum  MeshDriverCapability { CanWriteFaceDatasets = 1 << 0, CanWriteVertexDatasets = 1 << 1 }
 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)
 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...
 

Detailed Description

Holds metadata about mesh driver.

Since
QGIS 3.12

Definition at line 52 of file qgsprovidermetadata.h.

Member Enumeration Documentation

◆ 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.

Definition at line 61 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 
)

Constructs driver metadata with selected capabilities.

Parameters
namename/key of the driver
descriptionshort description of the driver
capabilitiesdriver's capabilities

Definition at line 254 of file qgsprovidermetadata.cpp.

Member Function Documentation

◆ capabilities()

QgsMeshDriverMetadata::MeshDriverCapabilities QgsMeshDriverMetadata::capabilities ( ) const

Returns the capabilities for this driver.

Definition at line 259 of file qgsprovidermetadata.cpp.

◆ description()

QString QgsMeshDriverMetadata::description ( ) const

Returns the description for this driver.

Definition at line 269 of file qgsprovidermetadata.cpp.

◆ name()

QString QgsMeshDriverMetadata::name ( ) const

Returns the name (key) for this driver.

Definition at line 264 of file qgsprovidermetadata.cpp.


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