qgssensorguiregistry.h

Go to the documentation of this file.

/***************************************************************************
                            qgssensorguiregistry.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 QGSSENSORGUIREGISTRY_H
#define QGSSENSORGUIREGISTRY_H
 
#include "qgis_gui.h"
#include "qgis_sip.h"
#include "qgsabstractsensor.h"
#include "qgssensorregistry.h"
#include "qgssensorwidget.h"
 
#include <QIcon>

class GUI_EXPORT QgsSensorAbstractGuiMetadata
{
  public:

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

    QString type() const { return mType; }

    QString visibleName() const { return mVisibleName; }

    virtual QIcon creationIcon() const { return QgsApplication::getThemeIcon( QStringLiteral( "/mSensor.svg" ) ); }
 
    /*
     * 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 QgsAbstractSensorWidget *createSensorWidget( QgsAbstractSensor *sensor ) SIP_TRANSFERBACK
    {
      Q_UNUSED( sensor )
      return nullptr;
    }

    virtual QgsAbstractSensor *createSensor( QObject *parent ) SIP_TRANSFERBACK
    {
      Q_UNUSED( parent )
      return nullptr;
    }
 
  private:
    QString mType;
    QString mVisibleName;
};

typedef std::function<QgsAbstractSensorWidget *( QgsAbstractSensor *sensor )> QgsSensorWidgetFunc SIP_SKIP;
 
#ifndef SIP_RUN

class GUI_EXPORT QgsSensorGuiMetadata : public QgsSensorAbstractGuiMetadata
{
  public:

    QgsSensorGuiMetadata( const QString &type, const QString &visibleName, const QIcon &creationIcon, const QgsSensorWidgetFunc &pfWidget = nullptr, const QgsSensorCreateFunc &pfCreateFunc = nullptr )
      : QgsSensorAbstractGuiMetadata( type, visibleName )
      , mIcon( creationIcon )
      , mWidgetFunc( pfWidget )
      , mCreateFunc( pfCreateFunc )
    {}

    QgsSensorWidgetFunc widgetFunction() const { return mWidgetFunc; }

    void setWidgetFunction( const QgsSensorWidgetFunc &function ) { mWidgetFunc = function; }

    QgsSensorCreateFunc sensorCreationFunction() const { return mCreateFunc; }

    void setSensorCreationFunction( const QgsSensorCreateFunc &function ) { mCreateFunc = function; }
 
    QIcon creationIcon() const override { return mIcon.isNull() ? QgsSensorAbstractGuiMetadata::creationIcon() : mIcon; }
    QgsAbstractSensorWidget *createSensorWidget( QgsAbstractSensor *sensor ) override { return mWidgetFunc ? mWidgetFunc( sensor ) : nullptr; }
    QgsAbstractSensor *createSensor( QObject *parent ) override { return mCreateFunc ? mCreateFunc( parent ) : nullptr; }
 
  protected:
    QIcon mIcon;
    QgsSensorWidgetFunc mWidgetFunc = nullptr;
    QgsSensorCreateFunc mCreateFunc = nullptr;
};
 
#endif

class GUI_EXPORT QgsSensorGuiRegistry : public QObject
{
    Q_OBJECT
 
  public:

    QgsSensorGuiRegistry( QObject *parent = nullptr );
    ~QgsSensorGuiRegistry() override;
 
    QgsSensorGuiRegistry( const QgsSensorGuiRegistry &rh ) = delete;
    QgsSensorGuiRegistry &operator=( const QgsSensorGuiRegistry &rh ) = delete;

    bool populate();

    QgsSensorAbstractGuiMetadata *sensorMetadata( const QString &type ) const;

    bool addSensorGuiMetadata( QgsSensorAbstractGuiMetadata *metadata SIP_TRANSFER );
 
    /*
     * 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.
     * "
     */

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

    QgsAbstractSensorWidget *createSensorWidget( QgsAbstractSensor *sensor ) const SIP_TRANSFERBACK;

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

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