qgsabstractsensor.h

Go to the documentation of this file.

/***************************************************************************
                             qgsabstractsensor.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 QGSABSTRACTSENSOR_H
#define QGSABSTRACTSENSOR_H
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QDateTime>
#include <QDomElement>
#include <QString>
#include <QVariant>
 
using namespace Qt::StringLiterals;

class CORE_EXPORT QgsAbstractSensor : public QObject
{
    //SIP_TYPEHEADER_INCLUDE( "qgsiodevicesensor.h" );
    //SIP_TYPEHEADER_INCLUDE( "qgssensorregistry.h" );
 
 
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( QgsAbstractSensor *item = qobject_cast< QgsAbstractSensor * >( sipCpp ) )
    {
      if ( item->type() == "tcp_socket"_L1 && dynamic_cast<QgsTcpSocketSensor *>( item ) != NULL )
      {
        sipType = sipType_QgsTcpSocketSensor;
      }
      else if ( item->type() == "udp_socket"_L1 && dynamic_cast<QgsUdpSocketSensor *>( item ) != NULL )
      {
        sipType = sipType_QgsUdpSocketSensor;
      }
#if defined( HAVE_QTSERIALPORT )
      else if ( item->type() == "serial_port"_L1 && dynamic_cast<QgsSerialPortSensor *>( item ) != NULL )
      {
        sipType = sipType_QgsSerialPortSensor;
      }
#endif
      else
      {
        sipType = sipType_QgsAbstractSensor;
      }
    }
    else
    {
      sipType = NULL;
    }
    SIP_END
#endif
 
    // clang-format off
  Q_OBJECT
 
  public:
    // clang-format on

    struct CORE_EXPORT SensorData
    {
        QVariant lastValue;

        QDateTime lastTimestamp;
    };

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

    QString id() const { return mId; }

    virtual QString type() const { return QString(); }

    QString name() const;

    void setName( const QString &name );

    Qgis::DeviceConnectionStatus status() const;

    void setStatus( Qgis::DeviceConnectionStatus status );

    void connectSensor();

    void disconnectSensor();

    QgsAbstractSensor::SensorData data() const;

    void setData( const QgsAbstractSensor::SensorData &data );

    QString errorString() const;

    bool writeXml( QDomElement &parentElement, QDomDocument &document ) const;

    bool readXml( const QDomElement &element, const QDomDocument &document );

    virtual bool writePropertiesToElement( QDomElement &element, QDomDocument &document ) const;

    virtual bool readPropertiesFromElement( const QDomElement &element, const QDomDocument &document );
 
  signals:

    void nameChanged();

    void statusChanged();

    void dataChanged();

    void errorOccurred( const QString &errorString );
 
  protected:
    virtual void handleConnect() = 0;

    virtual void handleDisconnect() = 0;
 
    QgsAbstractSensor::SensorData mData;
    QString mErrorString;
 
  private:
    QString mId;
    QString mName;
    Qgis::DeviceConnectionStatus mStatus = Qgis::DeviceConnectionStatus::Disconnected;
};
 
Q_DECLARE_METATYPE( QgsAbstractSensor * )
 
#endif //QGSABSTRACTSENSOR_H