Extend getString().

nChangedProgramModeToIDLE(), onChangedProgramModeToOOO(), startPhysicalLayer(),
stopPhysicalLayer(), reboot(), reset().
Add signals printTicketFinished,...,Error.

DCPlugin.pro

@@ -9,7 +9,7 @@ QT += serialport
 INCLUDEPATH += $${PWD}/plugins
 INCLUDEPATH += $${PWD}/include
 
-QMAKE_CXXFLAGS += -Wno-deprecated-copy
+QMAKE_CXXFLAGS += -Wno-deprecated-copy -O
 
 # default
 ARCH = PTU5
@@ -49,6 +49,8 @@ INTERFACE_DEFINITION = $${PWD}/src/ATBAPP/DeviceControllerInterface.h
 
 DEFINES += DEVICECONTROLLERPLUGIN_LIBRARY
 
+DEFINES += USE_DC_VMC_UNIFICATION
+
 # The following define makes your compiler emit warnings if you use
 # any Qt feature that has been marked deprecated (the exact warnings
 # depend on your compiler). Please consult the documentation of the
@@ -77,6 +79,7 @@ HEADERS += \
     src/ATBAPP/ATBMachineEvent.h \
     src/ATBAPP/ATBDeviceControllerPlugin.h \
     src/ATBAPP/Utils.h \
+    src/ATBAPP/UnifiedDCVMCInterface.h \
     src/ATBAPP/support/DBusControllerInterface.h \
     src/ATBAPP/support/JSON.h \
     src/ATBAPP/support/PTUSystem.h

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
-{
-
-public:
-    virtual const QString & getPluginInfo() = 0;
+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
+    };
+
+    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

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;
 }
 
-const 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;
+}
 
-const 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 @@ const QString ATBDeviceControllerPlugin::getString(nsDeviceControllerInterface::
     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;
 

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);
@@ -58,36 +58,99 @@ public:
     void requestAccount();
 
     // mandantory ATBAPP plugin methods: ------------------------------------------
-    nsDeviceControllerInterface::PLUGIN_STATE getState();
-    QString & getLastError();
-    const QString & getLastErrorDescription();
+    nsDeviceControllerInterface::PLUGIN_STATE getState() override;
+    QString const &getLastError() override;
+    QString const &getLastErrorDescription() override;
 
-    const QString & getPluginInfo();
+    virtual QStringList getPluginInfoList() override;
+    virtual const QString &getPluginInfo() override;
 
     // helpers e.g. for debug / log
-    const QString getString(nsDeviceControllerInterface::RESULT_STATE resultState);;
+    virtual QString const &getString(RESULT_STATE resultState) override;
 
 public slots:
-    void onChangedProgramModeToSELL();
-    void onChangedProgramModeToSERVICE();
-    void onChangedProgramModeToIDLE();
-    void onChangedProgramModeToOOO();
+    virtual void onChangedProgramModeToSELL() override;
+    virtual void onChangedProgramModeToSERVICE() override;
+    virtual void onChangedProgramModeToIDLE() override;
+    virtual void onChangedProgramModeToOOO() override;
 
-    void startPhysicalLayer();
-    void stopPhysicalLayer();
-    void reboot();
-    void reset();
+    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;
 

src/ATBAPP/DeviceControllerInterface.h

@@ -7,22 +7,23 @@
 #include <QString>
 
 #include "ATBAPPplugin.h"
+#include "UnifiedDCVMCInterface.h"
 
 namespace nsDeviceControllerInterface {
-    enum class PLUGIN_STATE : quint8;
-    enum class RESULT_STATE : quint8;
-    enum class CASH_STATE   : quint8;
-    enum class TICKET_VARIANT : quint8;
+    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 QObject
-                                , public ATBAPPplugin
+class DeviceControllerInterface : public QObject, public UnifiedDCVMCInterface
 {
     Q_OBJECT
     Q_INTERFACES(ATBAPPplugin)
+    Q_INTERFACES(UnifiedDCVMCInterface)
 
 public:
+
     virtual ~DeviceControllerInterface() {}
 
     /**
@@ -31,8 +32,7 @@ public:
      * @param settings
      * @return
      */
-    virtual nsDeviceControllerInterface::PLUGIN_STATE initDCPlugin(QObject *eventReceiver,
-                                                                   const QSettings & settings) = 0;
+    virtual PLUGIN_STATE initDCPlugin(QObject *eventReceiver, const QSettings & settings) = 0;
 
     // TASKS: Cash handling -------------------------------------------------------
     /**
@@ -60,10 +60,11 @@ public:
 
     // TASKS: printing ------------------------------------------------------------
     virtual void requestPrintTicket(const QHash<QString, QVariant> & printingData) = 0;
-    virtual void requestPrintTicket(nsDeviceControllerInterface::TICKET_VARIANT ticketVariant, const QHash<QString, QVariant> & printingData) = 0;
+    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;
@@ -73,7 +74,7 @@ public:
     // -> ATBAPPplugin::getPluginInfo()
 
     // helpers e.g. for debug / log
-    virtual const QString getString(nsDeviceControllerInterface::RESULT_STATE resultState) = 0;
+    virtual const QString &getString(nsDeviceControllerInterface::RESULT_STATE resultState) = 0;
 
 public slots:
     virtual void onChangedProgramModeToSELL() = 0;
@@ -86,7 +87,6 @@ public slots:
     virtual void reboot() = 0;
     virtual void reset() = 0;
 
-
 signals:
     void printTicketFinished(nsDeviceControllerInterface::RESULT_STATE resultState,
                                      const QString & errorCode,
@@ -117,7 +117,6 @@ signals:
                                      const QString & errorCode,
                                      const QString & errorDescription);
 
-
     /**
      * emitted e.g. if service door is opened
      */
@@ -139,9 +138,6 @@ signals:
     void requestAccountResponse(const QHash<QString, QVariant> & accountData);
 
 
-
-
-
     /**
      * emitted on error
      * depending on errorCode:
@@ -157,43 +153,7 @@ signals:
 
 };
 
-
 Q_DECLARE_INTERFACE(DeviceControllerInterface,
                     "eu.atb.ptu.plugin.DeviceControllerInterface/1.0")
 
-
-namespace nsDeviceControllerInterface {
-
-    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
-    };
-
-}
-
 #endif // DEVICECONTROLLERINTERFACE_H

src/ATBAPP/UnifiedDCInterface.cpp

@@ -0,0 +1,19 @@
+#include "DeviceControllerInterface.h"
+
+
+using UNIFIED_PLUGIN_STATE = UnifiedDCVMCInterface<DeviceControllerInterface>::UNIFIED_PLUGIN_STATE;
+
+
+template<>
+UNIFIED_PLUGIN_STATE UnifiedDCVMCInterface<DeviceControllerInterface>::initPlugin(QObject *eventReceiver, QSettings const &settings) {
+
+
+    switch(static_cast<DeviceControllerInterface*>(this)->initDCPlugin(eventReceiver, settings)) {
+    case nsDeviceControllerInterface::PLUGIN_STATE::INITIALIZED:
+        return UNIFIED_PLUGIN_STATE::INITIALIZED;
+    case nsDeviceControllerInterface::PLUGIN_STATE::NOT_INITIALIZED:
+        return UNIFIED_PLUGIN_STATE::NOT_INITIALIZED;
+    }
+
+    return UNIFIED_PLUGIN_STATE::NOT_INITIALIZED;
+}

src/ATBAPP/UnifiedDCVMCInterface.h

@@ -0,0 +1,62 @@
+#ifndef UNIFIED_DCVMC_INTERFACE_H_INCLUDED
+#define UNIFIED_DCVMC_INTERFACE_H_INCLUDED
+
+#include <QObject>
+#include <QSettings>
+
+#include <QtPlugin>
+
+#include <QSettings>
+#include <QString>
+
+#include "ATBAPPplugin.h"
+
+
+class UnifiedDCVMCInterface : public ATBAPPplugin {
+    Q_INTERFACES(ATBAPPplugin)
+
+public:
+    explicit UnifiedDCVMCInterface() = default;
+    virtual ~UnifiedDCVMCInterface() = default;
+
+    virtual QStringList getPluginInfoList() = 0;
+    virtual const QString &getPluginInfo() = 0;
+
+    // mandantory ATBAPP plugin methods:
+    virtual PLUGIN_STATE getState() = 0;
+    virtual QString const &getLastError() = 0;
+    virtual QString const &getLastErrorDescription() = 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;
+    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;
+};
+
+Q_DECLARE_INTERFACE(UnifiedDCVMCInterface,
+                    "eu.atb.ptu.plugin.UnifiedDCVMCInterface/1.0")
+
+#endif // UNIFIED_DCVMC_INTERFACE_H_INCLUDED