ADR Suggestion, Backends

[andped10]

Backends is a collection of language specific implementations to provide the required domain specific functionality to the GUI. The different backends are expected to share the same skeleton structure with an object to serve each of the pages (Gui/Pages) and other main elements in the GUI (Statusbar, plotting, ...).

It is recommended to have two backends

A. Mock backend

• Serve to enable a quick setup of GUI elements
• Written in QML
• Entry point: Backends/MockBackend.qml
• Non-functional mock properties and functions

B. Functional backend

• Serve to expose the domain specific logic implemented in the LIB to the GUI
• Written in Python and linked to Qt using PySide
• Entry point: Backends/Py/py_backend.py
• Functional properties and functions from LIB

Two layers

• 1st layer could be considered as the API
  • Exposes all properties and methods required by BackendWrapper
  • Code is a mix of Python and QML syntax
  • Only orchestration of the methods from the second layer
  • Relay QML signals
    • External QML signals to inform other modules
    • Internal QML signals to inform and trigger updates of other properties in the module
• 2nd layer is the logic level where the LIB methods are accessed
  • Pure Python code and syntax
  • The objects are expected to match a corresponding object in the LIB which domain specific functionality is being utilized