QGIS API Documentation  3.23.0-Master (22c16f2067)
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 , 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...
 
Q_DECL_DEPRECATED QgsMeshDriverMetadata (const QString &name, const QString &description, const MeshDriverCapabilities &capabilities, const QString &writeDatasetOnFileSuffix)
 Constructs driver metadata with selected capabilities. More...
 
 QgsMeshDriverMetadata (const QString &name, const QString &description, const MeshDriverCapabilities &capabilities, const QString &writeDatasetOnFileSuffix, const QString &writeMeshFrameOnFileSuffix, int maxVerticesPerface)
 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...
 
int maximumVerticesCountPerFace () const
 Returns the maximum number of vertices per face supported by the 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...
 
QString writeMeshFrameOnFileSuffix () const
 Returns the suffix used to write mesh on file. More...
 

Detailed Description

Holds metadata about mesh driver.

Since
QGIS 3.12

Definition at line 57 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.

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 66 of file qgsprovidermetadata.h.

Constructor & Destructor Documentation

◆ QgsMeshDriverMetadata() [1/3]

QgsMeshDriverMetadata::QgsMeshDriverMetadata ( )
default

Constructs default metadata without any capabilities.

◆ QgsMeshDriverMetadata() [2/3]

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

Constructs driver metadata with selected capabilities.

Parameters
namename/key of the driver
descriptionshort description of the driver
capabilitiesdriver's capabilities
writeDatasetOnFileSuffixsuffix used to write datasets on file
Deprecated:
QGIS 3.22

Definition at line 353 of file qgsprovidermetadata.cpp.

◆ QgsMeshDriverMetadata() [3/3]

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

Constructs driver metadata with selected capabilities.

Parameters
namename/key of the driver
descriptionshort description of the driver
capabilitiesdriver's capabilities
writeDatasetOnFileSuffixsuffix used to write datasets on file
writeMeshFrameOnFileSuffixsuffix used to write mesh frame on file
maxVerticesPerfacemaximum vertices count per face supported by the driver
Since
QGIS 3.22

Definition at line 364 of file qgsprovidermetadata.cpp.

Member Function Documentation

◆ capabilities()

QgsMeshDriverMetadata::MeshDriverCapabilities QgsMeshDriverMetadata::capabilities ( ) const

Returns the capabilities for this driver.

Definition at line 379 of file qgsprovidermetadata.cpp.

◆ description()

QString QgsMeshDriverMetadata::description ( ) const

Returns the description for this driver.

Definition at line 389 of file qgsprovidermetadata.cpp.

◆ maximumVerticesCountPerFace()

int QgsMeshDriverMetadata::maximumVerticesCountPerFace ( ) const

Returns the maximum number of vertices per face supported by the driver.

Since
QGIS 3.22

Definition at line 404 of file qgsprovidermetadata.cpp.

◆ name()

QString QgsMeshDriverMetadata::name ( ) const

Returns the name (key) for this driver.

Definition at line 384 of file qgsprovidermetadata.cpp.

◆ writeDatasetOnFileSuffix()

QString QgsMeshDriverMetadata::writeDatasetOnFileSuffix ( ) const

Returns the suffix used to write datasets on file.

Definition at line 394 of file qgsprovidermetadata.cpp.

◆ writeMeshFrameOnFileSuffix()

QString QgsMeshDriverMetadata::writeMeshFrameOnFileSuffix ( ) const

Returns the suffix used to write mesh on file.

Since
QGIS 3.22

Definition at line 399 of file qgsprovidermetadata.cpp.


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