Extend getString().

Implement getPluginInfoList() and extend getString().
Implement initVMCPlugin(), initPlugin().
2023-11-16 08:47:52 +01:00 · 2023-11-16 08:47:03 +01:00 · 2023-11-16 08:45:47 +01:00 · 2023-11-16 08:44:25 +01:00 · 2023-11-16 08:41:14 +01:00 · 2023-11-16 08:40:06 +01:00
5 changed files with 290 additions and 143 deletions
--- a/src/ATBAPP/ATBAPPplugin.h
+++ b/src/ATBAPP/ATBAPPplugin.h
@ -5,18 +5,63 @@
 * a simple class with only one method for plugin info
 */
 #include <QObject>
-#include <QString>
+#include <QStringList>

-class ATBAPPplugin
-{
+struct ATBAPPplugin {
+    enum class PLUGIN_STATE : quint8 {
+        NOT_INITIALIZED = 0,
+        INITIALIZED = 1
+    };
+    enum class RESULT_STATE : quint8 {
+        SUCCESS = 1,                // operation was successfull
+        ERROR_BACKEND,              // error from backend (e.g. backend replies with error)
+        ERROR_NETWORK,
+        ERROR_TIMEOUT,              // the operation timed out
+        ERROR_PROCESS,              // internal plugin error, should not occur (this is a bug in implementation)
+        ERROR_BUSY,
+        ERROR_STATE,
+        ERROR_RETRY,                // retry operation
+        INFO                        // informational (e.g. display a message, log something etc.)
+    };
+    enum class CASH_STATE   : quint8 {
+        CACHE_EMPTY,                // Cache still empty, default state
+        CACHE_INPUT,                // Coins are in Cache
+        OVERPAYED,
+        /* t.b.d. */
+    };
+    enum class TICKET_VARIANT : quint8 {
+        PARKING_TICKET,
+        RECEIPT,
+        ERROR_RECEIPT,
+        START_RECEIPT,   // e.g. Szeged Start
+        STOP_RECEIPT,    // e.g. Szeged Stop
+    };
+    enum class STEP : quint8 {
+        UP = 1,
+        DOWN = 2
+    };
+    enum class TERMINAL_STATE : quint8 {
+        NOT_AVAILABLE = 1,
+        AVAILABLE,
+        PREPARED_FOR_VENDING,
+        BUSY,
+        NEEDS_MAINTENANCE
+    };

-public:
-    virtual const QString & getPluginInfo() = 0;
+    virtual const QString &getPluginInfo() = 0;
+    virtual QStringList getPluginInfoList() {
+        return QStringList(QString());
+    }
 };

+using PLUGIN_STATE = ATBAPPplugin::PLUGIN_STATE;
+using RESULT_STATE = ATBAPPplugin::RESULT_STATE;
+using CASH_STATE = ATBAPPplugin::CASH_STATE;
+using TICKET_VARIANT = ATBAPPplugin::TICKET_VARIANT;
+using STEP = ATBAPPplugin::STEP;
+using TERMINAL_STATE = ATBAPPplugin::TERMINAL_STATE;
+
 Q_DECLARE_INTERFACE(ATBAPPplugin,
                    "eu.atb.ptu.plugin.ATBAPPplugin/0.9")

-
-
 #endif // ATBAPPPLUGIN_H
--- a/src/ATBAPP/ATBDeviceControllerPlugin.cpp
+++ b/src/ATBAPP/ATBDeviceControllerPlugin.cpp
@ -68,6 +68,32 @@ ATBDeviceControllerPlugin::ATBDeviceControllerPlugin(QObject *parent)

 ATBDeviceControllerPlugin::~ATBDeviceControllerPlugin() {}

+PLUGIN_STATE ATBDeviceControllerPlugin::initVMCPlugin(QObject *eventReceiver,
+                                                      QObject *atbSystem,
+                                                      QObject *hmiConfig,
+                                                      const QSettings &settings) {
+    Q_UNUSED(eventReceiver);
+    Q_UNUSED(atbSystem);
+    Q_UNUSED(hmiConfig);
+    Q_UNUSED(settings);
+
+    return PLUGIN_STATE::NOT_INITIALIZED;
+}
+
+PLUGIN_STATE ATBDeviceControllerPlugin::initPlugin(QObject *eventReceiver,
+                                                   QObject *atbSystem,
+                                                   QObject *hmiConfig,
+                                                   QSettings const &settings) {
+    Q_UNUSED(atbSystem);
+    Q_UNUSED(hmiConfig);
+
+    return initDCPlugin(eventReceiver, settings);
+}
+
+PLUGIN_STATE ATBDeviceControllerPlugin::initPlugin(QObject *eventReceiver, QSettings const &settings) {
+    return initDCPlugin(eventReceiver, settings);
+}
+
 PLUGIN_STATE ATBDeviceControllerPlugin::initDCPlugin(QObject *eventReceiver, const QSettings & settings)
 {
    this->eventReceiver = eventReceiver;
@ -1045,12 +1071,12 @@ PLUGIN_STATE ATBDeviceControllerPlugin::getState()
    return this->pluginState;
 }

-QString ATBDeviceControllerPlugin::getLastError()
+QString const &ATBDeviceControllerPlugin::getLastError()
 {
    return this->errorCode;
 }

-QString ATBDeviceControllerPlugin::getLastErrorDescription()
+QString const &ATBDeviceControllerPlugin::getLastErrorDescription()
 {
    return this->errorDescription;
 }
@ -1060,10 +1086,15 @@ const QString & ATBDeviceControllerPlugin::getPluginInfo()
    return this->pluginInfo;
 }

+QStringList ATBDeviceControllerPlugin::getPluginInfoList() {
+   pluginInfoList.clear();
+   return pluginInfoList;
+}

-QString ATBDeviceControllerPlugin::getString(nsDeviceControllerInterface::RESULT_STATE resultState)
+
+QString const &ATBDeviceControllerPlugin::getString(nsDeviceControllerInterface::RESULT_STATE resultState)
 {
-    QString str;
+    static QString str;

    switch (resultState) {
    case nsDeviceControllerInterface::RESULT_STATE::SUCCESS:
@ -1084,6 +1115,15 @@ QString ATBDeviceControllerPlugin::getString(nsDeviceControllerInterface::RESULT
    case nsDeviceControllerInterface::RESULT_STATE::INFO:
        str = QString("RESULT_STATE::INFO");
        break;
+    case nsDeviceControllerInterface::RESULT_STATE::ERROR_NETWORK:
+        str = QString("RESULT_STATE::ERROR_NETWORK");
+        break;
+    case nsDeviceControllerInterface::RESULT_STATE::ERROR_BUSY:
+        str = QString("RESULT_STATE::ERROR_BUSY");
+        break;
+    case nsDeviceControllerInterface::RESULT_STATE::ERROR_STATE:
+        str = QString("RESULT_STATE::ERROR_STATE");
+        break;
    }
    return str;

--- a/src/ATBAPP/ATBDeviceControllerPlugin.h
+++ b/src/ATBAPP/ATBDeviceControllerPlugin.h
@ -13,19 +13,16 @@

 #include "interfaces.h"

-#include <unistd.h>
-

 class DBusControllerInterface;
 class QTextCodec;


-using namespace nsDeviceControllerInterface;
+// using namespace nsDeviceControllerInterface;

 class QSettings;

-class ATBDeviceControllerPlugin :
-        public DeviceControllerInterface
+class ATBDeviceControllerPlugin : public DeviceControllerInterface
 {
    Q_OBJECT
    Q_INTERFACES(ATBAPPplugin)
@ -36,11 +33,14 @@ class ATBDeviceControllerPlugin :

 public:
    explicit ATBDeviceControllerPlugin(QObject *parent = nullptr);
-    ~ATBDeviceControllerPlugin();
+    virtual ~ATBDeviceControllerPlugin();

    // ----------------------------------------------------------------------------
    // interface:
-    PLUGIN_STATE initDCPlugin(QObject *eventReceiver, const QSettings & settings);
+    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QObject *atbSystem, QObject *hmiConfig, QSettings const &settings) override;
+    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QSettings const &settings) override;
+    virtual PLUGIN_STATE initVMCPlugin(QObject *eventReceiver, QObject *atbSystem, QObject *hmiConfig, const QSettings & settings) override;
+    virtual PLUGIN_STATE initDCPlugin(QObject *eventReceiver, const QSettings & settings) override;

    // TASKS: Cash handling -------------------------------------------------------
    void requestStartCashInput(const QString & amount);
@ -59,13 +59,14 @@ public:

    // mandantory ATBAPP plugin methods: ------------------------------------------
    nsDeviceControllerInterface::PLUGIN_STATE getState() override;
-    QString getLastError() override;
-    QString getLastErrorDescription() override;
+    QString const &getLastError() override;
+    QString const &getLastErrorDescription() override;

-    virtual const QString & getPluginInfo() override;
+    virtual QStringList getPluginInfoList() override;
+    virtual const QString &getPluginInfo() override;

    // helpers e.g. for debug / log
-    virtual QString getString(nsDeviceControllerInterface::RESULT_STATE resultState) override;
+    virtual QString const &getString(RESULT_STATE resultState) override;

 public slots:
    virtual void onChangedProgramModeToSELL() override;
@ -73,21 +74,83 @@ public slots:
    virtual void onChangedProgramModeToIDLE() override;
    virtual void onChangedProgramModeToOOO() override;

-    void startPhysicalLayer() override;
-    void stopPhysicalLayer() override;
-    void reboot() override;
-    void reset() override;
+    virtual void startPhysicalLayer() override;
+    virtual void stopPhysicalLayer() override;
+    virtual void reboot() override;
+    virtual void reset() override;



 signals:
-    // public Signals are defined in interface
+    void printTicketFinished(RESULT_STATE resultState,
+                             const QString & errorCode,
+                             const QString & errorDescription);
+    void printReceiptFinished(RESULT_STATE resultState,
+                              const QString & errorCode,
+                              const QString & errorDescription);
+
+    /**
+     * emitted on e.g. a coin input
+     */
+    void cashInputEvent(RESULT_STATE resultState,
+                                CASH_STATE cashState,
+                                const QString & newCashValue,
+                                /* additional variables? */
+                                const QString & errorCode,
+                                const QString & errorDescription);
+
+    /**
+     * emitted if cashInput has been stopped, e.g. in result to task requestStopCashInput():
+     *  -> shutter is blocked
+     *  -> no cash input is possible
+     *  -> coins are in cache
+     */
+    void cashInputFinished(RESULT_STATE resultState,
+                                     const QString & newCashValue,
+                                     /*  additional variables? */
+                                     const QString & errorCode,
+                                     const QString & errorDescription);
+
+
+    /**
+     * emitted e.g. if service door is opened
+     */
+    void requestModeSERVICE();
+
+    /**
+     * emitted e.g. if doors are closed
+     */
+    void requestModeIDLE();
+
+    /**
+     * emitted e.g. on severe errors
+     */
+    void requestModeOOO();
+
+    /**
+     * emitted e.g. if service door is opened
+     */
+    void requestAccountResponse(const QHash<QString, QVariant> & accountData);
+
+    /**
+     * emitted on error
+     * depending on errorCode:
+     * -> interrupt selling process
+     * -> machine can go to state OOO
+     * -> send error event to ISMAS
+     * -> ...
+     */
+    void Error(
+            /*  additional variables? */
+            const QString & errorCode,
+            const QString & errorDescription);


 private:
   QString errorCode;
   QString errorDescription;
   QString pluginInfo;
+   QStringList pluginInfoList;

   QList<int> templateList;

--- a/src/ATBAPP/DeviceControllerInterface.h
+++ b/src/ATBAPP/DeviceControllerInterface.h
@ -10,13 +10,13 @@
 #include "UnifiedDCVMCInterface.h"

 namespace nsDeviceControllerInterface {
-    using PLUGIN_STATE = UnifiedDCVMCInterface::PLUGIN_STATE;
-    using RESULT_STATE = UnifiedDCVMCInterface::RESULT_STATE;
-    using CASH_STATE = UnifiedDCVMCInterface::CASH_STATE;
-    using TICKET_VARIANT = UnifiedDCVMCInterface::TICKET_VARIANT;
+    using PLUGIN_STATE = ATBAPPplugin::PLUGIN_STATE;
+    using RESULT_STATE = ATBAPPplugin::RESULT_STATE;
+    using CASH_STATE = ATBAPPplugin::CASH_STATE;
+    using TICKET_VARIANT = ATBAPPplugin::TICKET_VARIANT;
 }

-class DeviceControllerInterface : public UnifiedDCVMCInterface
+class DeviceControllerInterface : public QObject, public UnifiedDCVMCInterface
 {
    Q_OBJECT
    Q_INTERFACES(ATBAPPplugin)
@ -24,10 +24,6 @@ class DeviceControllerInterface : public UnifiedDCVMCInterface

 public:

-    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QSettings const &settings) override {
-        return initDCPlugin(eventReceiver, settings);
-    }
-
    virtual ~DeviceControllerInterface() {}

    /**
@ -67,6 +63,94 @@ public:
    virtual void requestPrintTicket(TICKET_VARIANT ticketVariant, const QHash<QString, QVariant> & printingData) = 0;
    virtual void requestPrintReceipt(const QHash<QString, QVariant> & printingData) = 0;
    virtual void requestPrintReceipt(const QString & printingString) = 0;
+
+
+    // mandantory ATBAPP plugin methods:
+    virtual nsDeviceControllerInterface::PLUGIN_STATE getState() = 0;
+    virtual const QString & getLastError() = 0;
+    virtual const QString & getLastErrorDescription() = 0;
+
+    // return a plugin description in JSON or XML
+    // -> ATBAPPplugin::getPluginInfo()
+
+    // helpers e.g. for debug / log
+    virtual const QString &getString(nsDeviceControllerInterface::RESULT_STATE resultState) = 0;
+
+public slots:
+    virtual void onChangedProgramModeToSELL() = 0;
+    virtual void onChangedProgramModeToSERVICE() = 0;
+    virtual void onChangedProgramModeToIDLE() = 0;
+    virtual void onChangedProgramModeToOOO() = 0;
+
+    virtual void startPhysicalLayer() = 0;
+    virtual void stopPhysicalLayer() = 0;
+    virtual void reboot() = 0;
+    virtual void reset() = 0;
+
+signals:
+    void printTicketFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
+                                     const QString & errorCode,
+                                     const QString & errorDescription);
+    void printReceiptFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
+                                     const QString & errorCode,
+                                     const QString & errorDescription);
+
+    /**
+     * emitted on e.g. a coin input
+     */
+    void cashInputEvent(nsDeviceControllerInterface::RESULT_STATE resultState,
+                                nsDeviceControllerInterface::CASH_STATE cashState,
+                                const QString & newCashValue,
+                                /* additional variables? */
+                                const QString & errorCode,
+                                const QString & errorDescription);
+
+    /**
+     * emitted if cashInput has been stopped, e.g. in result to task requestStopCashInput():
+     *  -> shutter is blocked
+     *  -> no cash input is possible
+     *  -> coins are in cache
+     */
+    void cashInputFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
+                                     const QString & newCashValue,
+                                     /*  additional variables? */
+                                     const QString & errorCode,
+                                     const QString & errorDescription);
+
+    /**
+     * emitted e.g. if service door is opened
+     */
+    void requestModeSERVICE();
+
+    /**
+     * emitted e.g. if doors are closed
+     */
+    void requestModeIDLE();
+
+    /**
+     * emitted e.g. on severe errors
+     */
+    void requestModeOOO();
+
+    /**
+     * emitted e.g. if service door is opened
+     */
+    void requestAccountResponse(const QHash<QString, QVariant> & accountData);
+
+
+    /**
+     * emitted on error
+     * depending on errorCode:
+     * -> interrupt selling process
+     * -> machine can go to state OOO
+     * -> send error event to ISMAS
+     * -> ...
+     */
+    void Error(
+            /*  additional variables? */
+            const QString & errorCode,
+            const QString & errorDescription);
+
 };

 Q_DECLARE_INTERFACE(DeviceControllerInterface,
--- a/src/ATBAPP/UnifiedDCVMCInterface.h
+++ b/src/ATBAPP/UnifiedDCVMCInterface.h
@ -11,49 +11,38 @@

 #include "ATBAPPplugin.h"

-class UnifiedDCVMCInterface : public QObject, public ATBAPPplugin {

-    Q_OBJECT
+class UnifiedDCVMCInterface : public ATBAPPplugin {
    Q_INTERFACES(ATBAPPplugin)

 public:
-    enum class PLUGIN_STATE : quint8 {
-        NOT_INITIALIZED = 0,
-        INITIALIZED = 1
-    };
-    enum class RESULT_STATE : quint8 {
-        SUCCESS = 1,                // operation was successfull
-        ERROR_BACKEND,              // error from backend (e.g. backend replies with error)
-        ERROR_TIMEOUT,              // the operation timed out
-        ERROR_PROCESS,              // internal plugin error, should not occur (this is a bug in implementation)
-        ERROR_RETRY,                // retry operation
-        INFO                        // informational (e.g. display a message, log something etc.)
-    };
-    enum class CASH_STATE   : quint8 {
-        CACHE_EMPTY,                // Cache still empty, default state
-        CACHE_INPUT,                // Coins are in Cache
-        OVERPAYED,
-        /* t.b.d. */
-    };
-    enum class TICKET_VARIANT : quint8 {
-        PARKING_TICKET,
-        RECEIPT,
-        ERROR_RECEIPT,
-        START_RECEIPT,   // e.g. Szeged Start
-        STOP_RECEIPT,    // e.g. Szeged Stop
-    };
-
    explicit UnifiedDCVMCInterface() = default;
-    virtual ~UnifiedDCVMCInterface() {}
+    virtual ~UnifiedDCVMCInterface() = default;

-    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QSettings const &settings) = 0;
+    virtual QStringList getPluginInfoList() = 0;
+    virtual const QString &getPluginInfo() = 0;

    // mandantory ATBAPP plugin methods:
    virtual PLUGIN_STATE getState() = 0;
-    virtual QString getLastError() = 0;
-    virtual QString getLastErrorDescription() = 0;
+    virtual QString const &getLastError() = 0;
+    virtual QString const &getLastErrorDescription() = 0;

-    virtual QString getString(RESULT_STATE resultState) = 0;
+    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver,
+                                    QObject *atbSystem,
+                                    QObject *hmiConfig,
+                                    QSettings const &settings) = 0;
+
+    virtual PLUGIN_STATE initPlugin(QObject *eventReceiver, QSettings const &settings) = 0;
+
+    virtual PLUGIN_STATE initDCPlugin(QObject *eventReceiver,
+                                      const QSettings & settings) = 0;
+
+    virtual PLUGIN_STATE initVMCPlugin(QObject *eventReceiver,
+                                       QObject *atbSystem, QObject *hmiConfig,
+                                       const QSettings & settings) = 0;
+
+
+    virtual QString const &getString(RESULT_STATE resultState) = 0;

 public slots:
    virtual void onChangedProgramModeToSELL() = 0;
@ -65,83 +54,9 @@ public slots:
    virtual void stopPhysicalLayer() = 0;
    virtual void reboot() = 0;
    virtual void reset() = 0;
-
-signals:
-    void printTicketFinished(RESULT_STATE resultState,
-                             const QString & errorCode,
-                             const QString & errorDescription);
-    void printReceiptFinished(RESULT_STATE resultState,
-                              const QString & errorCode,
-                              const QString & errorDescription);
-
-    /**
-     * emitted on e.g. a coin input
-     */
-    void cashInputEvent(RESULT_STATE resultState,
-                                CASH_STATE cashState,
-                                const QString & newCashValue,
-                                /* additional variables? */
-                                const QString & errorCode,
-                                const QString & errorDescription);
-
-    /**
-     * emitted if cashInput has been stopped, e.g. in result to task requestStopCashInput():
-     *  -> shutter is blocked
-     *  -> no cash input is possible
-     *  -> coins are in cache
-     */
-    void cashInputFinished(RESULT_STATE resultState,
-                                     const QString & newCashValue,
-                                     /*  additional variables? */
-                                     const QString & errorCode,
-                                     const QString & errorDescription);
-
-
-    /**
-     * emitted e.g. if service door is opened
-     */
-    void requestModeSERVICE();
-
-    /**
-     * emitted e.g. if doors are closed
-     */
-    void requestModeIDLE();
-
-    /**
-     * emitted e.g. on severe errors
-     */
-    void requestModeOOO();
-
-    /**
-     * emitted e.g. if service door is opened
-     */
-    void requestAccountResponse(const QHash<QString, QVariant> & accountData);
-
-
-
-
-
-    /**
-     * emitted on error
-     * depending on errorCode:
-     * -> interrupt selling process
-     * -> machine can go to state OOO
-     * -> send error event to ISMAS
-     * -> ...
-     */
-    void Error(
-            /*  additional variables? */
-            const QString & errorCode,
-            const QString & errorDescription);
-
 };

 Q_DECLARE_INTERFACE(UnifiedDCVMCInterface,
                    "eu.atb.ptu.plugin.UnifiedDCVMCInterface/1.0")

-using PLUGIN_STATE = UnifiedDCVMCInterface::PLUGIN_STATE;
-using RESULT_STATE = UnifiedDCVMCInterface::RESULT_STATE;
-using CASH_STATE = UnifiedDCVMCInterface::CASH_STATE;
-using TICKET_VARIANT = UnifiedDCVMCInterface::TICKET_VARIANT;
-
 #endif // UNIFIED_DCVMC_INTERFACE_H_INCLUDED
Author	SHA1	Message	Date
Gerhard Hoffmann	d5f7a45a57	Extend getString().	2023-11-16 08:47:52 +01:00
Gerhard Hoffmann	18c98abc5b	Implement getPluginInfoList() and extend getString().	2023-11-16 08:47:03 +01:00
Gerhard Hoffmann	bdf2886aa4	Implement initVMCPlugin(), initPlugin().	2023-11-16 08:45:47 +01:00
Gerhard Hoffmann	b1304df2bf	Add signals and add pluginInfoList.	2023-11-16 08:44:25 +01:00
Gerhard Hoffmann	cf5d950647	Add getState(), getLastError(), getLastErrorDescription(), getString(), onChangedProgramModeToSELL(), onChangedProgramModeToSERVICE(), nChangedProgramModeToIDLE(), onChangedProgramModeToOOO(), startPhysicalLayer(), stopPhysicalLayer(), reboot(), reset(). Add signals printTicketFinished,...,Error.	2023-11-16 08:41:14 +01:00
Gerhard Hoffmann	ed99b7f3a3	Minor: remove initPlugin()-implementation.	2023-11-16 08:40:06 +01:00
Gerhard Hoffmann	62c3758bd1	Derive interface from QObject (to enable usage of qobject_cast) and UnifiedDCVMCInterface.	2023-11-16 08:38:46 +01:00
Gerhard Hoffmann	5d2bb75fca	Extend enums in nsDeviceControllerInterface.	2023-11-16 08:38:13 +01:00
Gerhard Hoffmann	2313b6bd42	Moved enums to ATBAPPplugin.h. Removed signals.	2023-11-16 08:36:16 +01:00
Gerhard Hoffmann	bf59e2d4b9	Add enums describing plugin status: PLUGIN_STATE, RESULT_STATE, CASH_STATE, TICKET_VARIANT, STEP.	2023-11-16 08:34:34 +01:00