QGIS API Documentation 3.37.0-Master (fdefdf9c27f)
Public Member Functions | List of all members
QgsBabelGpsDeviceFormat Class Reference

A babel format capable of interacting directly with a GPS device. More...

#include <qgsbabelgpsdevice.h>

Inheritance diagram for QgsBabelGpsDeviceFormat:
Inheritance graph
[legend]

Public Member Functions

 QgsBabelGpsDeviceFormat ()=default
 Default constructor. More...
 
 QgsBabelGpsDeviceFormat (const QString &waypointDownloadCommand, const QString &waypointUploadCommand, const QString &routeDownloadCommand, const QString &routeUploadCommand, const QString &trackDownloadCommand, const QString &trackUploadCommand)
 Constructor for QgsBabelGpsDeviceFormat. More...
 
QStringList exportCommand (const QString &babel, Qgis::GpsFeatureType type, const QString &in, const QString &out, Qgis::BabelCommandFlags flags=Qgis::BabelCommandFlags()) const override
 Generates a command for exporting GPS data into a different format using babel. More...
 
QStringList importCommand (const QString &babel, Qgis::GpsFeatureType type, const QString &in, const QString &out, Qgis::BabelCommandFlags flags=Qgis::BabelCommandFlags()) const override
 Generates a command for importing data into a GPS format using babel. More...
 
- Public Member Functions inherited from QgsAbstractBabelFormat
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...
 

Additional Inherited Members

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

Detailed Description

A babel format capable of interacting directly with a GPS device.

Since
QGIS 3.22

Definition at line 35 of file qgsbabelgpsdevice.h.

Constructor & Destructor Documentation

◆ QgsBabelGpsDeviceFormat() [1/2]

QgsBabelGpsDeviceFormat::QgsBabelGpsDeviceFormat ( )
default

Default constructor.

◆ QgsBabelGpsDeviceFormat() [2/2]

QgsBabelGpsDeviceFormat::QgsBabelGpsDeviceFormat ( const QString &  waypointDownloadCommand,
const QString &  waypointUploadCommand,
const QString &  routeDownloadCommand,
const QString &  routeUploadCommand,
const QString &  trackDownloadCommand,
const QString &  trackUploadCommand 
)

Constructor for QgsBabelGpsDeviceFormat.

Parameters
waypointDownloadCommandcommand for downloading waypoints from device
waypointUploadCommandcommand for uploading waypoints to device
routeDownloadCommandcommand for downloading routes from device
routeUploadCommandcommand for uploading routes to device
trackDownloadCommandcommand for downloading tracks from device
trackUploadCommandcommand for uploading tracks to device

Definition at line 20 of file qgsbabelgpsdevice.cpp.

Member Function Documentation

◆ exportCommand()

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

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 from QgsAbstractBabelFormat.

Definition at line 102 of file qgsbabelgpsdevice.cpp.

◆ importCommand()

QStringList QgsBabelGpsDeviceFormat::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 64 of file qgsbabelgpsdevice.cpp.


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