QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Signals | Public Member Functions | Protected Slots | Protected Attributes | Private Member Functions | 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]
Collaboration diagram for QgsGPSConnection:
Collaboration graph
[legend]

Public Types

enum  Status { NotConnected, Connected, DataReceived, GPSDataReceived }
 

Signals

void stateChanged (const QgsGPSInformation &info)
 
void nmeaSentenceReceived (const QString &substring)
 

Public Member Functions

 QgsGPSConnection (QIODevice *dev)
 Constructor. More...
 
virtual ~QgsGPSConnection ()
 
bool connect ()
 Opens connection to device. More...
 
bool close ()
 Closes connection to device. More...
 
void setSource (QIODevice *source)
 Sets the GPS source. More...
 
Status status () const
 Returns the status. More...
 
QgsGPSInformation currentGPSInformation () const
 Returns the current gps information (lat, lon, etc.) More...
 

Protected Slots

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

Protected Attributes

QIODevice * mSource
 Data source (e.g. More...
 
QgsGPSInformation mLastGPSInformation
 Last state of the gps related variables (e.g. More...
 
Status mStatus
 Connection status. More...
 

Private Member Functions

void cleanupSource ()
 Closes and deletes mSource. More...
 
void clearLastGPSInformation ()
 

Detailed Description

Abstract base class for connection to a GPS device.

Definition at line 60 of file qgsgpsconnection.h.

Member Enumeration Documentation

Enumerator
NotConnected 
Connected 
DataReceived 
GPSDataReceived 

Definition at line 65 of file qgsgpsconnection.h.

Constructor & Destructor Documentation

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.

References clearLastGPSInformation(), 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
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.

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
virtual void QgsGPSConnection::parseData ( )
protectedpure virtualslot

Parse available data source content.

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
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
QIODevice* QgsGPSConnection::mSource
protected
Status QgsGPSConnection::mStatus
protected

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