QGIS API Documentation  2.11.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups 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 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. More...
 
Status status () const
 Returns the status. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual  ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

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. More...
 
QIODevicemSource
 Data source (e.g. More...
 
Status mStatus
 Connection status. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

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.

QgsGPSConnection::~QgsGPSConnection ( )
virtual

Definition at line 38 of file qgsgpsconnection.cpp.

Member Function Documentation

bool QgsGPSConnection::close ( )

Closes connection to device.

Definition at line 58 of file qgsgpsconnection.cpp.

bool QgsGPSConnection::connect ( )

Opens connection to device.

Definition at line 43 of file qgsgpsconnection.cpp.

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.

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.

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.

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.

QIODevice* QgsGPSConnection::mSource
protected

Data source (e.g.

serial device, socket, file,...)

Definition at line 98 of file qgsgpsconnection.h.

Status QgsGPSConnection::mStatus
protected

Connection status.

Definition at line 102 of file qgsgpsconnection.h.


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