QGIS API Documentation  3.23.0-Master (b5237dafc3)
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
QgsAbstractBabelFormat Class Reference

Abstract base class for babel GPS formats. More...

#include <qgsbabelformat.h>

Inheritance diagram for QgsAbstractBabelFormat:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsAbstractBabelFormat ()=default
 
Qgis::BabelFormatCapabilities capabilities () const
 Returns the format's capabilities. More...
 
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. More...
 
virtual QStringList importCommand (const QString &babel, Qgis::GpsFeatureType featureType, const QString &input, const QString &output, Qgis::BabelCommandFlags flags=Qgis::BabelCommandFlags()) const
 Generates a command for importing data into a GPS format using babel. More...
 
QString name () const
 Returns the format's name. More...
 

Protected Member Functions

 QgsAbstractBabelFormat (const QString &name=QString())
 Constructor for QgsAbstractBabelFormat, with the specified name. More...
 

Static Protected Member Functions

static QString featureTypeToArgument (Qgis::GpsFeatureType type)
 Converts a GPS feature type to the equivalent babel argument. More...
 

Protected Attributes

Qgis::BabelFormatCapabilities mCapabilities = Qgis::BabelFormatCapabilities()
 
QString mName
 Name of format. More...
 

Detailed Description

Abstract base class for babel GPS formats.

Since
QGIS 3.22

Definition at line 33 of file qgsbabelformat.h.

Constructor & Destructor Documentation

◆ ~QgsAbstractBabelFormat()

virtual QgsAbstractBabelFormat::~QgsAbstractBabelFormat ( )
virtualdefault

◆ QgsAbstractBabelFormat()

QgsAbstractBabelFormat::QgsAbstractBabelFormat ( const QString &  name = QString())
explicitprotected

Constructor for QgsAbstractBabelFormat, with the specified name.

Definition at line 22 of file qgsbabelformat.cpp.

Member Function Documentation

◆ capabilities()

Qgis::BabelFormatCapabilities QgsAbstractBabelFormat::capabilities ( ) const

Returns the format's capabilities.

Definition at line 56 of file qgsbabelformat.cpp.

◆ exportCommand()

QStringList QgsAbstractBabelFormat::exportCommand ( const QString &  babel,
Qgis::GpsFeatureType  featureType,
const QString &  input,
const QString &  output,
Qgis::BabelCommandFlags  flags = Qgis::BabelCommandFlags() 
) const
virtual

Generates a command for exporting GPS data into a different format using babel.

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

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

Reimplemented in QgsBabelGpsDeviceFormat.

Definition at line 51 of file qgsbabelformat.cpp.

◆ featureTypeToArgument()

QString QgsAbstractBabelFormat::featureTypeToArgument ( Qgis::GpsFeatureType  type)
staticprotected

Converts a GPS feature type to the equivalent babel argument.

Definition at line 27 of file qgsbabelformat.cpp.

◆ importCommand()

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

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 in QgsBabelGpsDeviceFormat, and QgsBabelSimpleImportFormat.

Definition at line 46 of file qgsbabelformat.cpp.

◆ name()

QString QgsAbstractBabelFormat::name ( ) const

Returns the format's name.

Definition at line 41 of file qgsbabelformat.cpp.

Member Data Documentation

◆ mCapabilities

Qgis::BabelFormatCapabilities QgsAbstractBabelFormat::mCapabilities = Qgis::BabelFormatCapabilities()
protected

Definition at line 98 of file qgsbabelformat.h.

◆ mName

QString QgsAbstractBabelFormat::mName
protected

Name of format.

Definition at line 96 of file qgsbabelformat.h.


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