Contains utility functions for working with data providers. More...

#include <qgsproviderutils.h>

Public Types
enum	SublayerCompletenessFlag : int { SublayerCompletenessFlag::IgnoreUnknownFeatureCount = 1 << 0, SublayerCompletenessFlag::IgnoreUnknownGeometryType = 1 << 1 }
	Flags which control how QgsProviderUtils::sublayerDetailsAreIncomplete() tests for completeness. More...

Static Public Member Functions
static bool	sublayerDetailsAreIncomplete (const QList< QgsProviderSublayerDetails > &details, QgsProviderUtils::SublayerCompletenessFlags flags=QgsProviderUtils::SublayerCompletenessFlags())
	Returns `true` if the sublayer details are incomplete, and require a more in-depth scan. More...

static QString	suggestLayerNameFromFilePath (const QString &path)
	Suggests a suitable layer name given only a file path. More...

Detailed Description

Contains utility functions for working with data providers.

Since: QGIS 3.22

Definition at line 33 of file qgsproviderutils.h.

Member Enumeration Documentation

◆ SublayerCompletenessFlag

enum QgsProviderUtils::SublayerCompletenessFlag : int

strong

Flags which control how QgsProviderUtils::sublayerDetailsAreIncomplete() tests for completeness.

Enumerator
IgnoreUnknownFeatureCount	Indicates that an unknown feature count should not be considered as incomplete.
IgnoreUnknownGeometryType	Indicates that an unknown geometry type should not be considered as incomplete.

Definition at line 40 of file qgsproviderutils.h.

Member Function Documentation

◆ sublayerDetailsAreIncomplete()

bool QgsProviderUtils::sublayerDetailsAreIncomplete	(	const QList< QgsProviderSublayerDetails > &	details,
		QgsProviderUtils::SublayerCompletenessFlags	flags = `QgsProviderUtils::SublayerCompletenessFlags()`
	)

static

Returns true if the sublayer details are incomplete, and require a more in-depth scan.

For instance, if the details contain any vector sublayers with unknown geometry types then a query with the Qgis::SublayerQueryFlag::ResolveGeometryType flag is required.

The flags argument can be used to control the level of completeness required during the test.

Definition at line 22 of file qgsproviderutils.cpp.

◆ suggestLayerNameFromFilePath()

QString QgsProviderUtils::suggestLayerNameFromFilePath ( const QString & path )

static

Suggests a suitable layer name given only a file path.

Usually this corresponds to the base file name of path (e.g. "rivers" for a path of "c:/my data/water/rivers.shp"). However some data formats which use fixed file paths (such as aigrid files) will instead return the parent directory name (e.g. "rivers" for a path of "c:/my data/water/rivers/hdr.adf").

Definition at line 54 of file qgsproviderutils.cpp.

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

/build/qgis-3.26.3+32focal/src/core/providers/qgsproviderutils.h
/build/qgis-3.26.3+32focal/src/core/providers/qgsproviderutils.cpp