QGIS API Documentation
2.2.0-Valmiera
|
Holds data provider key, description, and associated shared library file information. More...
#include <qgsprovidermetadata.h>
Public Member Functions | |
QgsProviderMetadata (const QString &_key, const QString &_description, const QString &_library) | |
const QString & | key () const |
this returns the unique key associated with the provider | |
const QString & | description () const |
this returns descriptive text for the provider | |
const QString & | library () const |
this returns the library file name |
Private Attributes | |
QString | key_ |
unique key for data provider | |
QString | description_ |
associated terse description | |
QString | library_ |
file path |
Holds data provider key, description, and associated shared library file information.
The metadata class is used in a lazy load implementation in QgsProviderRegistry. To save memory, data providers are only actually loaded via QLibrary calls if they're to be used. (Though they're all iteratively loaded once to get their metadata information, and then unloaded when the QgsProviderRegistry is created.) QgsProviderMetadata supplies enough information to be able to later load the associated shared library object.
Definition at line 37 of file qgsprovidermetadata.h.
QgsProviderMetadata::QgsProviderMetadata | ( | const QString & | _key, |
const QString & | _description, | ||
const QString & | _library | ||
) |
Definition at line 23 of file qgsprovidermetadata.cpp.
QString const & QgsProviderMetadata::description | ( | ) | const |
this returns descriptive text for the provider
This is used to provide a descriptive list of available data providers.
Definition at line 36 of file qgsprovidermetadata.cpp.
References description_.
QString const & QgsProviderMetadata::key | ( | ) | const |
this returns the unique key associated with the provider
This key string is used for the associative container in QgsProviderRegistry
Definition at line 31 of file qgsprovidermetadata.cpp.
References key_.
QString const & QgsProviderMetadata::library | ( | ) | const |
this returns the library file name
This is used to QLibrary calls to load the data provider.
Definition at line 41 of file qgsprovidermetadata.cpp.
References library_.
Referenced by QgsProviderRegistry::library().
|
private |
associated terse description
Definition at line 67 of file qgsprovidermetadata.h.
Referenced by description().
|
private |
unique key for data provider
Definition at line 64 of file qgsprovidermetadata.h.
Referenced by key().
|
private |