QgsGpsConnection Class Reference

Abstract base class for connection to a GPS device. More...

#include <qgsgpsconnection.h>

Inheritance diagram for QgsGpsConnection:

Public Types
enum	Status { NotConnected , Connected , DataReceived , GPSDataReceived }

Signals
void	nmeaSentenceReceived (const QString &substring)
void	stateChanged (const QgsGpsInformation &info)

Public Member Functions
	QgsGpsConnection (QIODevice *dev)
	Constructor. More...
	~QgsGpsConnection () override
bool	close ()
	Closes connection to device. More...
bool	connect ()
	Opens connection to device. More...
QgsGpsInformation	currentGPSInformation () const
	Returns the current gps information (lat, lon, etc.) More...
void	setSource (QIODevice *source)
	Sets the GPS source. The class takes ownership of the device class. More...
Status	status () const
	Returns the status. Possible state are not connected, connected, data received. More...

Protected Slots
virtual void	parseData ()=0
	Parse available data source content. More...

Protected Attributes
QgsGpsInformation	mLastGPSInformation
	Last state of the gps related variables (e.g. position, time, ...) More...
std::unique_ptr< QIODevice >	mSource
	Data source (e.g. serial device, socket, file,...) More...
Status	mStatus = NotConnected
	Connection status. More...

Detailed Description

Abstract base class for connection to a GPS device.

Definition at line 266 of file qgsgpsconnection.h.

Member Enumeration Documentation

Status

enum QgsGpsConnection::Status

Enumerator
NotConnected
Connected
DataReceived
GPSDataReceived

Definition at line 288 of file qgsgpsconnection.h.

Constructor & Destructor Documentation

QgsGpsConnection()

QgsGpsConnection::QgsGpsConnection

(

QIODevice *

dev

)

Constructor.

Parameters

dev	input device for the connection (e.g. serial device). The class takes ownership of the object

Definition at line 106 of file qgsgpsconnection.cpp.

~QgsGpsConnection()

QgsGpsConnection::~QgsGpsConnection ( )

override

Definition at line 114 of file qgsgpsconnection.cpp.

Member Function Documentation

close()

bool QgsGpsConnection::close

(

)

Closes connection to device.

Definition at line 134 of file qgsgpsconnection.cpp.

connect()

bool QgsGpsConnection::connect

(

)

Opens connection to device.

Definition at line 119 of file qgsgpsconnection.cpp.

currentGPSInformation()

QgsGpsInformation QgsGpsConnection::currentGPSInformation ( ) const

inline

Returns the current gps information (lat, lon, etc.)

Definition at line 314 of file qgsgpsconnection.h.

nmeaSentenceReceived

void QgsGpsConnection::nmeaSentenceReceived ( const QString &  substring )

signal

parseData

virtual void QgsGpsConnection::parseData ( )

protectedpure virtualslot

Parse available data source content.

setSource()

void QgsGpsConnection::setSource

(

QIODevice *

source

)

Sets the GPS source. The class takes ownership of the device class.

Definition at line 154 of file qgsgpsconnection.cpp.

stateChanged

void QgsGpsConnection::stateChanged ( const QgsGpsInformation &  info )

signal

status()

Status QgsGpsConnection::status ( ) const

inline

Returns the status. Possible state are not connected, connected, data received.

Definition at line 311 of file qgsgpsconnection.h.

Member Data Documentation

mLastGPSInformation

QgsGpsInformation QgsGpsConnection::mLastGPSInformation

protected

Last state of the gps related variables (e.g. position, time, ...)

Definition at line 324 of file qgsgpsconnection.h.

mSource

std::unique_ptr< QIODevice > QgsGpsConnection::mSource

protected

Data source (e.g. serial device, socket, file,...)

Definition at line 322 of file qgsgpsconnection.h.

mStatus

Status QgsGpsConnection::mStatus = NotConnected

protected

Connection status.

Definition at line 326 of file qgsgpsconnection.h.

---

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

• /build/qgis-3.18.1+99unstable/src/core/gps/qgsgpsconnection.h
• /build/qgis-3.18.1+99unstable/src/core/gps/qgsgpsconnection.cpp