QGIS API Documentation  2.99.0-Master (6a61179)
Public Types | Signals | Public Member Functions | Protected Slots | Protected Attributes | List of all members
QgsGPSConnection Class Referenceabstract

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

#include <qgsgpsconnection.h>

Inheritance diagram for QgsGPSConnection:
Inheritance graph
[legend]

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...
 
virtual ~QgsGPSConnection ()
 
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...
 
QIODevice * mSource
 Data source (e.g. serial device, socket, file,...) More...
 
Status mStatus
 Connection status. More...
 

Detailed Description

Abstract base class for connection to a GPS device.

Definition at line 61 of file qgsgpsconnection.h.

Member Enumeration Documentation

§ Status

Enumerator
NotConnected 
Connected 
DataReceived 
GPSDataReceived 

Definition at line 66 of file qgsgpsconnection.h.

Constructor & Destructor Documentation

§ QgsGPSConnection()

QgsGPSConnection::QgsGPSConnection ( QIODevice *  dev)

Constructor.

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

Definition at line 32 of file qgsgpsconnection.cpp.

§ ~QgsGPSConnection()

QgsGPSConnection::~QgsGPSConnection ( )
virtual

Definition at line 38 of file qgsgpsconnection.cpp.

Member Function Documentation

§ close()

bool QgsGPSConnection::close ( )

Closes connection to device.

Definition at line 58 of file qgsgpsconnection.cpp.

§ connect()

bool QgsGPSConnection::connect ( )

Opens connection to device.

Definition at line 43 of file qgsgpsconnection.cpp.

§ currentGPSInformation()

QgsGPSInformation QgsGPSConnection::currentGPSInformation ( ) const
inline

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

Definition at line 91 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 79 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 88 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 101 of file qgsgpsconnection.h.

§ mSource

QIODevice* QgsGPSConnection::mSource
protected

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

Definition at line 99 of file qgsgpsconnection.h.

§ mStatus

Status QgsGPSConnection::mStatus
protected

Connection status.

Definition at line 103 of file qgsgpsconnection.h.


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