QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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 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...
 

Detailed Description

Abstract base class for connection to a GPS device.

Member Enumeration Documentation

Enumerator
NotConnected 
Connected 
DataReceived 
GPSDataReceived 

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
QgsGPSConnection::~QgsGPSConnection ( )
virtual

Member Function Documentation

bool QgsGPSConnection::close ( )

Closes connection to device.

bool QgsGPSConnection::connect ( )

Opens connection to device.

QgsGPSInformation QgsGPSConnection::currentGPSInformation ( ) const
inline

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

void QgsGPSConnection::nmeaSentenceReceived ( const QString &  substring)
signal
virtual void QgsGPSConnection::parseData ( )
protectedpure virtualslot

Parse available data source content.

void QgsGPSConnection::setSource ( QIODevice *  source)

Sets the GPS source.

The class takes ownership of the device class

void QgsGPSConnection::stateChanged ( const QgsGPSInformation info)
signal
Status QgsGPSConnection::status ( ) const
inline

Returns the status.

Possible state are not connected, connected, data received

Member Data Documentation

QgsGPSInformation QgsGPSConnection::mLastGPSInformation
protected

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

position, time, ...)

QIODevice* QgsGPSConnection::mSource
protected

Data source (e.g.

serial device, socket, file,...)

Status QgsGPSConnection::mStatus
protected

Connection status.


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