qgsiodevicesensor.h

Go to the documentation of this file.

/***************************************************************************
                             qgsiodevicesensor.h
                             ---------------------------
    begin                : March 2023
    copyright            : (C) 2023 by Mathieu Pellerin
    email                : mathieu at opengis dot ch
 ***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
#ifndef QGSIODEVICESENSOR_H
#define QGSIODEVICESENSOR_H
 
#include "qgsconfig.h"
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractsensor.h"
 
#include <QBuffer>
#include <QDomElement>
#include <QTcpSocket>
#include <QUdpSocket>
 
#if defined( HAVE_QTSERIALPORT )
#include <QSerialPort>
#endif

class CORE_EXPORT QgsIODeviceSensor : public QgsAbstractSensor
{
 
    Q_OBJECT
 
  public:

    explicit QgsIODeviceSensor( QObject *parent = nullptr ) : QgsAbstractSensor( parent ) {}
    ~QgsIODeviceSensor() override;

    QIODevice *iODevice() const;
 
  protected:

    void initIODevice( QIODevice *device SIP_TRANSFER );
 
  protected slots:

    virtual void parseData();
 
  private:
 
    std::unique_ptr<QIODevice> mIODevice;
 
};

class CORE_EXPORT QgsTcpSocketSensor : public QgsIODeviceSensor
{
 
    Q_OBJECT
 
  public:

    explicit QgsTcpSocketSensor( QObject *parent = nullptr );
    ~QgsTcpSocketSensor() override = default;

    static QgsTcpSocketSensor *create( QObject *parent ) SIP_FACTORY;
 
    QString type() const override;

    QString hostName() const;

    void setHostName( const QString &hostName );

    int port() const;

    void setPort( int port );
 
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document ) override;
 
  protected:
 
    void handleConnect() override;
    void handleDisconnect() override;
 
  private slots:
 
    void socketStateChanged( const QAbstractSocket::SocketState socketState );
    void handleError( QAbstractSocket::SocketError error );
 
  private:
 
    QTcpSocket *mTcpSocket = nullptr;
 
    QString mHostName;
    int mPort = 0;
 
};

class CORE_EXPORT QgsUdpSocketSensor : public QgsIODeviceSensor
{
 
    Q_OBJECT
 
  public:

    explicit QgsUdpSocketSensor( QObject *parent = nullptr );
    ~QgsUdpSocketSensor() override = default;

    static QgsUdpSocketSensor *create( QObject *parent ) SIP_FACTORY;
 
    QString type() const override;

    QString hostName() const;

    void setHostName( const QString &hostName );

    int port() const;

    void setPort( int port );
 
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document ) override;
 
  protected:
 
    void handleConnect() override;
    void handleDisconnect() override;
 
  private slots:
 
    void socketStateChanged( const QAbstractSocket::SocketState socketState );
    void handleError( QAbstractSocket::SocketError error );
 
  private:
 
    std::unique_ptr<QUdpSocket> mUdpSocket;
    QBuffer *mBuffer = nullptr;
 
    QString mHostName;
    int mPort = 0;
 
};
 
#if defined( HAVE_QTSERIALPORT )
SIP_IF_FEATURE( HAVE_QTSERIALPORT )
 

class CORE_EXPORT QgsSerialPortSensor : public QgsIODeviceSensor
{
 
    Q_OBJECT
 
  public:

    explicit QgsSerialPortSensor( QObject *parent = nullptr );
    ~QgsSerialPortSensor() override = default;

    static QgsSerialPortSensor *create( QObject *parent ) SIP_FACTORY;
 
    QString type() const override;

    QString portName() const;

    void setPortName( const QString &portName );

    QSerialPort::BaudRate baudRate() const;

    void setBaudRate( const QSerialPort::BaudRate &baudRate );

    QByteArray delimiter() const;

    void setDelimiter( const QByteArray &delimiter );
 
    bool writePropertiesToElement( QDomElement &element, QDomDocument &document ) const override;
    bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document ) override;
 
  protected:
 
    void handleConnect() override;
    void handleDisconnect() override;
 
  protected slots:
 
    void parseData() override;
 
  private slots:
 
    void handleError( QSerialPort::SerialPortError error );
 
  private:
 
    QSerialPort *mSerialPort = nullptr;
 
    QString mPortName;
    QSerialPort::BaudRate mBaudRate = QSerialPort::Baud9600;
    QByteArray mDelimiter;
    bool mFirstDelimiterHit = false;
    QByteArray mDataBuffer;
 
};
SIP_END
#endif
 
#endif //QGSIODEVICESENSOR_H