qgssensorregistry.h

Go to the documentation of this file.

/***************************************************************************
                            qgssensorregistry.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 QGSSENSORREGISTRY_H
#define QGSSENSORREGISTRY_H
 
#include "qgis_core.h"
#include "qgis_sip.h"
#include "qgsabstractsensor.h"
#include "qgsapplication.h"

class CORE_EXPORT QgsSensorAbstractMetadata
{
  public:

    QgsSensorAbstractMetadata( const QString &type, const QString &visibleName )
      : mType( type )
      , mVisibleName( visibleName )
    {}
 
    virtual ~QgsSensorAbstractMetadata() = default;

    QString type() const { return mType; }

    QString visibleName() const { return mVisibleName; }
 
    /*
     * IMPORTANT: While it seems like /Factory/ would be the correct annotations here, that's not
     * the case.
     * As per Phil Thomson's advice on https://www.riverbankcomputing.com/pipermail/pyqt/2017-July/039450.html:
     *
     * "
     * /Factory/ is used when the instance returned is guaranteed to be new to Python.
     * In this case it isn't because it has already been seen when being returned by QgsProcessingAlgorithm::createInstance()
     * (However for a different sub-class implemented in C++ then it would be the first time it was seen
     * by Python so the /Factory/ on create() would be correct.)
     *
     * You might try using /TransferBack/ on create() instead - that might be the best compromise.
     * "
     */

    virtual QgsAbstractSensor *createSensor( QObject *parent ) = 0 SIP_TRANSFERBACK;
 
  private:
 
    QString mType;
    QString mVisibleName;
};

typedef std::function<QgsAbstractSensor *( QObject *parent )> QgsSensorCreateFunc SIP_SKIP;
 
#ifndef SIP_RUN

class CORE_EXPORT QgsSensorMetadata : public QgsSensorAbstractMetadata
{
  public:

    QgsSensorMetadata( const QString &type, const QString &visibleName,
                       const QgsSensorCreateFunc &pfCreate )
      : QgsSensorAbstractMetadata( type, visibleName )
      , mCreateFunc( pfCreate )
    {}

    QgsSensorCreateFunc createFunction() const { return mCreateFunc; }
 
    QgsAbstractSensor *createSensor( QObject *parent ) override { return mCreateFunc ? mCreateFunc( parent ) : nullptr; }
 
  protected:
    QgsSensorCreateFunc mCreateFunc = nullptr;
 
};
 
#endif

class CORE_EXPORT QgsSensorRegistry : public QObject
{
    Q_OBJECT
 
  public:

    QgsSensorRegistry( QObject *parent = nullptr );
    ~QgsSensorRegistry() override;

    bool populate();
 
    QgsSensorRegistry( const QgsSensorRegistry &rh ) = delete;
    QgsSensorRegistry &operator=( const QgsSensorRegistry &rh ) = delete;

    QgsSensorAbstractMetadata *sensorMetadata( const QString &type ) const;
 
    /*
     * IMPORTANT: While it seems like /Factory/ would be the correct annotations here, that's not
     * the case.
     * As per Phil Thomson's advice on https://www.riverbankcomputing.com/pipermail/pyqt/2017-July/039450.html:
     *
     * "
     * /Factory/ is used when the instance returned is guaranteed to be new to Python.
     * In this case it isn't because it has already been seen when being returned by QgsProcessingAlgorithm::createInstance()
     * (However for a different sub-class implemented in C++ then it would be the first time it was seen
     * by Python so the /Factory/ on create() would be correct.)
     *
     * You might try using /TransferBack/ on create() instead - that might be the best compromise.
     * "
     */

    bool addSensorType( QgsSensorAbstractMetadata *metadata SIP_TRANSFER );

    bool removeSensorType( const QString &type );

    QgsAbstractSensor *createSensor( const QString &type, QObject *parent = nullptr ) const SIP_TRANSFERBACK;

    QMap<QString, QString> sensorTypes() const;
 
  signals:

    void sensorAdded( const QString &type, const QString &name );
 
  private:
 
#ifdef SIP_RUN
    QgsSensorRegistry( const QgsSensorRegistry &rh );
#endif
 
    QMap<QString, QgsSensorAbstractMetadata *> mMetadata;
 
};
 
#endif //QGSSENSORREGISTRY_H