QgsGPSConnection Class Reference

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

#include <qgsgpsconnection.h>

Inheritance diagram for QgsGPSConnection:

Collaboration diagram for QgsGPSConnection:

List of all members.

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.
virtual	~QgsGPSConnection ()
bool	close ()
	Closes connection to device.
bool	connect ()
	Opens connection to device.
QgsGPSInformation	currentGPSInformation () const
	Returns the current gps information (lat, lon, etc.)
void	setSource (QIODevice *source)
	Sets the GPS source.
Status	status () const
	Returns the status.
Protected Slots
virtual void	parseData ()=0
	Parse available data source content.
Protected Attributes
QgsGPSInformation	mLastGPSInformation
	Last state of the gps related variables (e.g.
QIODevice *	mSource
	Data source (e.g.
Status	mStatus
	Connection status.
Private Member Functions
void	cleanupSource ()
	Closes and deletes mSource.
void	clearLastGPSInformation ()

---

Detailed Description

Abstract base class for connection to a GPS device.

Definition at line 60 of file qgsgpsconnection.h.

---

Member Enumeration Documentation

enum QgsGPSConnection::Status

Enumerator:

NotConnected
Connected
DataReceived
GPSDataReceived

Definition at line 65 of file qgsgpsconnection.h.

---

Constructor & Destructor Documentation

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 32 of file qgsgpsconnection.cpp.

References clearLastGPSInformation(), connect(), and parseData().

QgsGPSConnection::~QgsGPSConnection

(

)

[virtual]

Definition at line 38 of file qgsgpsconnection.cpp.

References cleanupSource().

---

Member Function Documentation

void QgsGPSConnection::cleanupSource

(

)

[private]

Closes and deletes mSource.

Definition at line 69 of file qgsgpsconnection.cpp.

References mSource.

Referenced by setSource(), and ~QgsGPSConnection().

void QgsGPSConnection::clearLastGPSInformation

(

)

[private]

Definition at line 86 of file qgsgpsconnection.cpp.

References QgsGPSInformation::direction, QgsGPSInformation::elevation, QgsGPSInformation::fixMode, QgsGPSInformation::fixType, QgsGPSInformation::hacc, QgsGPSInformation::hdop, QgsGPSInformation::latitude, QgsGPSInformation::longitude, mLastGPSInformation, QgsGPSInformation::pdop, QgsGPSInformation::quality, QgsGPSInformation::satellitesInView, QgsGPSInformation::satellitesUsed, QgsGPSInformation::satInfoComplete, QgsGPSInformation::satPrn, QgsGPSInformation::speed, QgsGPSInformation::status, QgsGPSInformation::utcDateTime, QgsGPSInformation::vacc, and QgsGPSInformation::vdop.

Referenced by QgsGPSConnection(), and setSource().

bool QgsGPSConnection::close

(

)

Closes connection to device.

Definition at line 58 of file qgsgpsconnection.cpp.

References mSource.

bool QgsGPSConnection::connect

(

)

Opens connection to device.

Definition at line 43 of file qgsgpsconnection.cpp.

References Connected, mSource, and mStatus.

Referenced by QgsGPSConnection(), QgsGpsdConnection::QgsGpsdConnection(), QgsQtLocationConnection::startGPS(), and QgsQtLocationConnection::startSatelliteMonitor().

QgsGPSInformation QgsGPSConnection::currentGPSInformation

(

)

const [inline]

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

Definition at line 90 of file qgsgpsconnection.h.

void QgsGPSConnection::nmeaSentenceReceived

(

const QString &

substring

)

[signal]

Referenced by QgsNMEAConnection::processStringBuffer().

virtual void QgsGPSConnection::parseData

(

)

[protected, pure virtual, slot]

Parse available data source content.

Implemented in QgsQtLocationConnection, and QgsNMEAConnection.

Referenced by QgsGPSConnection().

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.

References cleanupSource(), clearLastGPSInformation(), and mSource.

void QgsGPSConnection::stateChanged

(

const QgsGPSInformation &

info

)

[signal]

Referenced by QgsQtLocationConnection::broadcastConnectionAvailable(), QgsNMEAConnection::parseData(), QgsQtLocationConnection::parseData(), QgsQtLocationConnection::satellitesInUseUpdated(), and QgsQtLocationConnection::satellitesInViewUpdated().

Status QgsGPSConnection::status

(

)

const [inline]

Returns the status.

Possible state are not connected, connected, data received

Definition at line 87 of file qgsgpsconnection.h.

Referenced by QgsGPSDetector::detected().

---

Member Data Documentation

QgsGPSInformation QgsGPSConnection::mLastGPSInformation [protected]

Last state of the gps related variables (e.g.

position, time, ...)

Definition at line 100 of file qgsgpsconnection.h.

Referenced by QgsQtLocationConnection::broadcastConnectionAvailable(), clearLastGPSInformation(), QgsNMEAConnection::parseData(), QgsQtLocationConnection::parseData(), QgsNMEAConnection::processGGASentence(), QgsNMEAConnection::processGSASentence(), QgsNMEAConnection::processGSVSentence(), QgsNMEAConnection::processRMCSentence(), QgsNMEAConnection::processVTGSentence(), QgsQtLocationConnection::satellitesInUseUpdated(), and QgsQtLocationConnection::satellitesInViewUpdated().

QIODevice* QgsGPSConnection::mSource [protected]

Data source (e.g.

serial device, socket, file,...)

Definition at line 98 of file qgsgpsconnection.h.

Referenced by cleanupSource(), close(), connect(), QgsGpsdConnection::connected(), QgsGpsdConnection::error(), QgsNMEAConnection::parseData(), QgsGpsdConnection::QgsGpsdConnection(), and setSource().

Status QgsGPSConnection::mStatus [protected]

Connection status.

Definition at line 102 of file qgsgpsconnection.h.

Referenced by QgsQtLocationConnection::broadcastConnectionAvailable(), connect(), QgsNMEAConnection::parseData(), QgsQtLocationConnection::parseData(), and QgsNMEAConnection::processStringBuffer().

---

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

• src/core/gps/qgsgpsconnection.h
• src/core/gps/qgsgpsconnection.cpp