nqrduck/nqrduck-spectrometer
1
0
Fork 0
mirror of https://github.com/nqrduck/nqrduck-spectrometer.git synced 2024-11-09 12:30:01 +00:00
Code Issues Projects Releases Packages Wiki Activity

Added docstrings.

Browse source
This commit is contained in:
jupfi 2023-07-05 07:57:26 +02:00
parent dc0fe9bc20
commit 86a1a8ed5a
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
src/nqrduck_spectrometer/view.py
View file

@ -7,7 +7,12 @@ from .widget import Ui_Form
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
class SpectrometerView(ModuleView): class SpectrometerView(ModuleView):
def __init__(self, module): def __init__(self, module):
"""This class is the view for the spectrometer module. It contains the menu buttons for the different spectrometers.
It also contains the stacked widget that shows the different spectrometer views.
:param module: The spectrometer module that this view belongs to.
"""
super().__init__(module) super().__init__(module)
widget = QWidget() widget = QWidget()
@ -17,20 +22,32 @@ class SpectrometerView(ModuleView):
self._actions = dict() self._actions = dict()
def on_active_spectrometer_changed(self, module): def on_active_spectrometer_changed(self, module):
"""This method is called when the active spectrometer is changed.
It changes the active view in the stacked widget to the one that was just activated.
:param module: The BaseSpectrometer module that was just activated.
"""
self._ui_form.stackedWidget.setCurrentWidget(module._inner_view) self._ui_form.stackedWidget.setCurrentWidget(module._inner_view)
def on_spectrometer_widget_changed(self, widget): def on_spectrometer_widget_changed(self, widget):
"""This method is called when a new spectrometer widget is added to the module.
It adds the widget to the stacked widget and sets it as the current widget.
:param widget: The widget that was added to the module.
"""
logger.debug("Adding module widget to stacked widget: %s", widget) logger.debug("Adding module widget to stacked widget: %s", widget)
self._ui_form.stackedWidget.addWidget(widget) self._ui_form.stackedWidget.addWidget(widget)
self._ui_form.stackedWidget.setCurrentWidget(widget) self._ui_form.stackedWidget.setCurrentWidget(widget)
def on_spectrometer_added(self, module): def on_spectrometer_added(self, module):
"""This method changes the active spectrometer to the one that was just added.""" """This method changes the active spectrometer to the one that was just added.
:param module: The BaseSpectrometer module that was just added.
"""
module.change_spectrometer.connect(self.on_menu_button_clicked) module.change_spectrometer.connect(self.on_menu_button_clicked)
self.on_spectrometer_widget_changed(module._inner_view) self.on_spectrometer_widget_changed(module._inner_view)
def create_menu_entry(self): def create_menu_entry(self):
"""This method creates the menu entry for the spectrometer module. It creates a menu item for each spectrometer that is available.
"""
logger.debug("Creating menu entry for spectrometer module") logger.debug("Creating menu entry for spectrometer module")
menu_item = QMenu("Hardware") menu_item = QMenu("Hardware")
logger.debug("Available spectrometer models: %s", self._module.model._available_spectrometers) logger.debug("Available spectrometer models: %s", self._module.model._available_spectrometers)