QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QgsBabelSimpleImportFormat Class Reference

A babel format capable of converting input files to GPX files. More...

#include <qgsbabelformat.h>

Inheritance diagram for QgsBabelSimpleImportFormat:
Inheritance graph
[legend]

Public Member Functions

 QgsBabelSimpleImportFormat (const QString &format, const QString &description, Qgis::BabelFormatCapabilities capabilities, const QStringList extensions=QStringList())
 Constructor for QgsBabelSimpleImportFormat.
 
QString description () const
 Returns the friendly description for the format.
 
QStringList extensions () const
 Returns the list of known extensions for the format, e.g.
 
QStringList importCommand (const QString &babel, Qgis::GpsFeatureType featureType, const QString &input, const QString &output, Qgis::BabelCommandFlags flags=Qgis::BabelCommandFlags()) const override
 Generates a command for importing data into a GPS format using babel.
 
- Public Member Functions inherited from QgsAbstractBabelFormat
virtual ~QgsAbstractBabelFormat ()=default
 
Qgis::BabelFormatCapabilities capabilities () const
 Returns the format's capabilities.
 
virtual QStringList exportCommand (const QString &babel, Qgis::GpsFeatureType featureType, const QString &input, const QString &output, Qgis::BabelCommandFlags flags=Qgis::BabelCommandFlags()) const
 Generates a command for exporting GPS data into a different format using babel.
 
QString name () const
 Returns the format's name.
 

Additional Inherited Members

- Protected Member Functions inherited from QgsAbstractBabelFormat
 QgsAbstractBabelFormat (const QString &name=QString())
 Constructor for QgsAbstractBabelFormat, with the specified name.
 
- Static Protected Member Functions inherited from QgsAbstractBabelFormat
static QString featureTypeToArgument (Qgis::GpsFeatureType type)
 Converts a GPS feature type to the equivalent babel argument.
 
- Protected Attributes inherited from QgsAbstractBabelFormat
Qgis::BabelFormatCapabilities mCapabilities = Qgis::BabelFormatCapabilities()
 
QString mName
 Name of format.
 

Detailed Description

A babel format capable of converting input files to GPX files.

Since
QGIS 3.22

Definition at line 109 of file qgsbabelformat.h.

Constructor & Destructor Documentation

◆ QgsBabelSimpleImportFormat()

QgsBabelSimpleImportFormat::QgsBabelSimpleImportFormat ( const QString &  format,
const QString &  description,
Qgis::BabelFormatCapabilities  capabilities,
const QStringList  extensions = QStringList() 
)

Constructor for QgsBabelSimpleImportFormat.

The format argument specifies the babel identifier for the input format.

The description argument specified a descriptive name for the format.

The capabilities argument must reflect whether the format is capable of handling waypoints, routes and/or tracks.

The optional extensions argument can be used to populate a list of known file extensions for the format (e.g. "csv", "txt").

Definition at line 66 of file qgsbabelformat.cpp.

Member Function Documentation

◆ description()

QString QgsBabelSimpleImportFormat::description ( ) const
inline

Returns the friendly description for the format.

Definition at line 132 of file qgsbabelformat.h.

◆ extensions()

QStringList QgsBabelSimpleImportFormat::extensions ( ) const
inline

Returns the list of known extensions for the format, e.g.

"csv", "txt".

Definition at line 137 of file qgsbabelformat.h.

◆ importCommand()

QStringList QgsBabelSimpleImportFormat::importCommand ( const QString &  babel,
Qgis::GpsFeatureType  featureType,
const QString &  input,
const QString &  output,
Qgis::BabelCommandFlags  flags = Qgis::BabelCommandFlags() 
) const
overridevirtual

Generates a command for importing data into a GPS format using babel.

Parameters
babelbabel path to the babel executable
featureTypetype of GPS feature to import
inputinput data path
outputoutput path
flagsoptional flags to control how babel command is generated

Returns an empty list if the format does not support imports (see capabilities()).

Reimplemented from QgsAbstractBabelFormat.

Definition at line 77 of file qgsbabelformat.cpp.


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