Restructure codebase - part 1

plugins/UM3NetworkPrinting/src/UltimakerNetworkedPrinterOutputDevice.py

@@ -0,0 +1,102 @@
+# Copyright (c) 2019 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+from typing import List, Optional, Dict
+
+from PyQt5.QtCore import pyqtProperty, pyqtSignal, QObject, pyqtSlot
+
+from cura.PrinterOutput.Models.PrinterOutputModel import PrinterOutputModel
+from cura.PrinterOutput.NetworkedPrinterOutputDevice import NetworkedPrinterOutputDevice, AuthState
+from plugins.UM3NetworkPrinting.src.Models.UM3PrintJobOutputModel import UM3PrintJobOutputModel
+
+
+## Output device class that forms the basis of Ultimaker networked printer output devices.
+#  Currently used for local networking and cloud printing using Ultimaker Connect.
+#  This base class primarily contains all the Qt properties and slots needed for the monitor page to work.
+class UltimakerNetworkedPrinterOutputDevice(NetworkedPrinterOutputDevice):
+
+    # Signal emitted when the status of the print jobs for this cluster were changed over the network.
+    printJobsChanged = pyqtSignal()
+
+    # Signal emitted when the currently visible printer card in the UI was changed by the user.
+    activePrinterChanged = pyqtSignal()
+
+    # Notify can only use signals that are defined by the class that they are in, not inherited ones.
+    # Therefore we create a private signal used to trigger the printersChanged signal.
+    _clusterPrintersChanged = pyqtSignal()
+
+    # States indicating if a print job is queued.
+    QUEUED_PRINT_JOBS_STATES = {"queued", "error"}
+
+    def __init__(self, device_id, address, properties, connection_type, parent=None) -> None:
+        super().__init__(device_id=device_id, address=address, properties=properties, connection_type=connection_type,
+                         parent=parent)
+
+        # Keeps track of all print jobs in the cluster.
+        self._print_jobs = []  # type: List[UM3PrintJobOutputModel]
+
+        # Keep track of the printer currently selected in the UI.
+        self._active_printer = None  # type: Optional[PrinterOutputModel]
+
+        # By default we are not authenticated. This state will be changed later.
+        self._authentication_state = AuthState.NotAuthenticated
+
+    # Get all print jobs for this cluster.
+    @pyqtProperty("QVariantList", notify=printJobsChanged)
+    def printJobs(self) -> List[UM3PrintJobOutputModel]:
+        return self._print_jobs
+
+    # Get all print jobs for this cluster that are queued.
+    @pyqtProperty("QVariantList", notify=printJobsChanged)
+    def queuedPrintJobs(self) -> List[UM3PrintJobOutputModel]:
+        return [print_job for print_job in self._print_jobs if print_job.state in self.QUEUED_PRINT_JOBS_STATES]
+
+    # Get all print jobs for this cluster that are currently printing.
+    @pyqtProperty("QVariantList", notify=printJobsChanged)
+    def activePrintJobs(self) -> List[UM3PrintJobOutputModel]:
+        return [print_job for print_job in self._print_jobs if
+                print_job.assignedPrinter is not None and print_job.state not in self.QUEUED_PRINT_JOBS_STATES]
+
+    # Get the amount of printers in the cluster.
+    @pyqtProperty(int, notify=_clusterPrintersChanged)
+    def clusterSize(self) -> int:
+        return self._cluster_size
+
+    # Get the amount of printer in the cluster per type.
+    @pyqtProperty("QVariantList", notify=_clusterPrintersChanged)
+    def connectedPrintersTypeCount(self) -> List[Dict[str, str]]:
+        printer_count = {}  # type: Dict[str, int]
+        for printer in self._printers:
+            if printer.type in printer_count:
+                printer_count[printer.type] += 1
+            else:
+                printer_count[printer.type] = 1
+        result = []
+        for machine_type in printer_count:
+            result.append({"machine_type": machine_type, "count": str(printer_count[machine_type])})
+        return result
+
+    # Get a list of all printers.
+    @pyqtProperty("QVariantList", notify=_clusterPrintersChanged)
+    def printers(self) -> List[PrinterOutputModel]:
+        return self._printers
+
+    # Get the currently active printer in the UI.
+    @pyqtProperty(QObject, notify=activePrinterChanged)
+    def activePrinter(self) -> Optional[PrinterOutputModel]:
+        return self._active_printer
+
+    # Set the currently active printer from the UI.
+    @pyqtSlot(QObject, name="setActivePrinter")
+    def setActivePrinter(self, printer: Optional[PrinterOutputModel]) -> None:
+        if self.activePrinter == printer:
+            return
+        self._active_printer = printer
+        self.activePrinterChanged.emit()
+
+    @pyqtSlot(name="openPrintJobControlPanel")
+    def openPrintJobControlPanel(self) -> None:
+        raise NotImplementedError("openPrintJobControlPanel must be implemented")
+
+    @pyqtSlot(name="openPrinterControlPanel")
+    def openPrinterControlPanel(self) -> None:
+        raise NotImplementedError("openPrinterControlPanel must be implemented")