QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | Static Public Attributes | List of all members
QgsBabelFormatRegistry Class Reference
core library

A registry for QgsAbstractBabelFormat GPSBabel formats. More...

#include <qgsbabelformatregistry.h>

Public Member Functions

 QgsBabelFormatRegistry ()
 Constructor for QgsBabelFormatRegistry. More...
 
 QgsBabelFormatRegistry (const QgsBabelFormatRegistry &rh)=delete
 QgsBabelFormatRegistry cannot be copied. More...
 
 ~QgsBabelFormatRegistry ()
 
QgsBabelGpsDeviceFormat * deviceFormat (const QString &name)
 Returns a registered device format by name. More...
 
QStringList deviceNames () const
 Returns a list of the names of all registered devices. More...
 
QMap< QString, QgsBabelGpsDeviceFormat * > devices () const
 Returns a map of device name to device format. More...
 
QString importFileFilter () const
 Returns a file filter string representing all registered import formats. More...
 
QgsBabelSimpleImportFormat * importFormat (const QString &name)
 Returns a registered import format by name. More...
 
QgsBabelSimpleImportFormat * importFormatByDescription (const QString &description)
 Returns a registered import format by description. More...
 
QStringList importFormatNames () const
 Returns a list of the names of all registered import formats. More...
 
QgsBabelFormatRegistry & operator= (const QgsBabelFormatRegistry &rh)=delete
 QgsBabelFormatRegistry cannot be copied. More...
 
void reloadFromSettings ()
 Reloads the registry's members from the currently stored configuration. More...
 

Static Public Attributes

static const QgsSettingsEntryString * settingsBabelRteDownload = new QgsSettingsEntryString( QStringLiteral( "rtedownload" ), sTreeBabelDevices )
 
static const QgsSettingsEntryString * settingsBabelRteUpload = new QgsSettingsEntryString( QStringLiteral( "rteupload" ), sTreeBabelDevices )
 
static const QgsSettingsEntryString * settingsBabelTrkDownload = new QgsSettingsEntryString( QStringLiteral( "trkdownload" ), sTreeBabelDevices )
 
static const QgsSettingsEntryString * settingsBabelTrkUpload = new QgsSettingsEntryString( QStringLiteral( "trkupload" ), sTreeBabelDevices )
 
static const QgsSettingsEntryString * settingsBabelWptDownload = new QgsSettingsEntryString( QStringLiteral( "wptdownload" ), sTreeBabelDevices )
 
static const QgsSettingsEntryString * settingsBabelWptUpload = new QgsSettingsEntryString( QStringLiteral( "wptupload" ), sTreeBabelDevices )
 
static QgsSettingsTreeNamedListNode * sTreeBabelDevices = QgsSettingsTree::sTreeGps->createNamedListNode( QStringLiteral( "babel-devices" ) )
 

Detailed Description

A registry for QgsAbstractBabelFormat GPSBabel formats.

QgsBabelFormatRegistry is not usually directly created, but rather accessed through QgsApplication::gpsBabelFormatRegistry().

Since
QGIS 3.22

Definition at line 37 of file qgsbabelformatregistry.h.

Constructor & Destructor Documentation

◆ QgsBabelFormatRegistry() [1/2]

QgsBabelFormatRegistry::QgsBabelFormatRegistry ( )

Constructor for QgsBabelFormatRegistry.

The registry will automatically be populated with standard formats, and with devices previously configured and stored in QSettings.

Definition at line 36 of file qgsbabelformatregistry.cpp.

◆ ~QgsBabelFormatRegistry()

QgsBabelFormatRegistry::~QgsBabelFormatRegistry ( )

Definition at line 187 of file qgsbabelformatregistry.cpp.

◆ QgsBabelFormatRegistry() [2/2]

QgsBabelFormatRegistry::QgsBabelFormatRegistry ( const QgsBabelFormatRegistry &  rh)
delete

QgsBabelFormatRegistry cannot be copied.

Member Function Documentation

◆ deviceFormat()

QgsBabelGpsDeviceFormat * QgsBabelFormatRegistry::deviceFormat ( const QString &  name)

Returns a registered device format by name.

See also
deviceNames().

Definition at line 256 of file qgsbabelformatregistry.cpp.

◆ deviceNames()

QStringList QgsBabelFormatRegistry::deviceNames ( ) const

Returns a list of the names of all registered devices.

Definition at line 251 of file qgsbabelformatregistry.cpp.

◆ devices()

QMap< QString, QgsBabelGpsDeviceFormat * > QgsBabelFormatRegistry::devices ( ) const

Returns a map of device name to device format.

See also
deviceFormat()
deviceNames()

Definition at line 261 of file qgsbabelformatregistry.cpp.

◆ importFileFilter()

QString QgsBabelFormatRegistry::importFileFilter ( ) const

Returns a file filter string representing all registered import formats.

Definition at line 218 of file qgsbabelformatregistry.cpp.

◆ importFormat()

QgsBabelSimpleImportFormat * QgsBabelFormatRegistry::importFormat ( const QString &  name)

Returns a registered import format by name.

See also
importFormatNames()
importFormatByDescription()

Definition at line 198 of file qgsbabelformatregistry.cpp.

◆ importFormatByDescription()

QgsBabelSimpleImportFormat * QgsBabelFormatRegistry::importFormatByDescription ( const QString &  description)

Returns a registered import format by description.

See also
importFormat()

Definition at line 203 of file qgsbabelformatregistry.cpp.

◆ importFormatNames()

QStringList QgsBabelFormatRegistry::importFormatNames ( ) const

Returns a list of the names of all registered import formats.

Definition at line 193 of file qgsbabelformatregistry.cpp.

◆ operator=()

QgsBabelFormatRegistry & QgsBabelFormatRegistry::operator= ( const QgsBabelFormatRegistry &  rh)
delete

QgsBabelFormatRegistry cannot be copied.

◆ reloadFromSettings()

void QgsBabelFormatRegistry::reloadFromSettings ( )

Reloads the registry's members from the currently stored configuration.

Definition at line 266 of file qgsbabelformatregistry.cpp.

Member Data Documentation

◆ settingsBabelRteDownload

const QgsSettingsEntryString * QgsBabelFormatRegistry::settingsBabelRteDownload = new QgsSettingsEntryString( QStringLiteral( "rtedownload" ), sTreeBabelDevices )
static

Definition at line 47 of file qgsbabelformatregistry.h.

◆ settingsBabelRteUpload

const QgsSettingsEntryString * QgsBabelFormatRegistry::settingsBabelRteUpload = new QgsSettingsEntryString( QStringLiteral( "rteupload" ), sTreeBabelDevices )
static

Definition at line 48 of file qgsbabelformatregistry.h.

◆ settingsBabelTrkDownload

const QgsSettingsEntryString * QgsBabelFormatRegistry::settingsBabelTrkDownload = new QgsSettingsEntryString( QStringLiteral( "trkdownload" ), sTreeBabelDevices )
static

Definition at line 49 of file qgsbabelformatregistry.h.

◆ settingsBabelTrkUpload

const QgsSettingsEntryString * QgsBabelFormatRegistry::settingsBabelTrkUpload = new QgsSettingsEntryString( QStringLiteral( "trkupload" ), sTreeBabelDevices )
static

Definition at line 50 of file qgsbabelformatregistry.h.

◆ settingsBabelWptDownload

const QgsSettingsEntryString * QgsBabelFormatRegistry::settingsBabelWptDownload = new QgsSettingsEntryString( QStringLiteral( "wptdownload" ), sTreeBabelDevices )
static

Definition at line 45 of file qgsbabelformatregistry.h.

◆ settingsBabelWptUpload

const QgsSettingsEntryString * QgsBabelFormatRegistry::settingsBabelWptUpload = new QgsSettingsEntryString( QStringLiteral( "wptupload" ), sTreeBabelDevices )
static

Definition at line 46 of file qgsbabelformatregistry.h.

◆ sTreeBabelDevices

QgsSettingsTreeNamedListNode* QgsBabelFormatRegistry::sTreeBabelDevices = QgsSettingsTree::sTreeGps->createNamedListNode( QStringLiteral( "babel-devices" ) )
inlinestatic

Definition at line 43 of file qgsbabelformatregistry.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4