KaptureControlGui/KCG/Documentation/source/Dev/code/widgets/acquiresettings.rst

.. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.


.. module:: acquiresettings


.. _acquiresettings:



Module acquiresettings
======================


This Module Is the Acquiresettings subWindow.  

.. py:class:: AcquireSettingsTab(kcgw.KCGWidgets)

    A single tab in the acquire settings window  

    .. py:method:: __init__(self, board_id, same_as_widgets, parent=None)


    .. py:method:: build_same_as_list(self)

        Build the list to show in the same-as drop down menu  


    .. py:method:: same_as(self)

        Toggle SameAs functionality  


    .. py:method:: update_external_trigger(self, state)

        Update the use external trigger tick  

        :param state: the state to set the tick to  

    .. py:method:: use_external_trigger(self, state, update_config=True)

        Set use external trigger to state  

        :param state: the state to set to  
        :param update_config: true to update the board config  

    .. py:method:: set_value_silent(self, element, value)

        Set a Value silent without notifying observers  

        :param element: what element  
        :param value: set to what value  

    .. py:method:: tick_silent(self, element, state)

        Tick a tickbox without notifying observers  

        :param element: what tickbox  
        :param state: (bool) to what state  

    .. py:method:: set_values(self)

        Set Initial Values when creating this Window.  
        This will read the appropriate Values from the base.backend.board.BoardConfiguration instance used in the gui.  


    .. py:method:: on_number_of_orbits_changed(self)

        Handle the change of the number of orbits  

    .. py:method:: on_number_of_skipped_orbits_changed(self)

        Handle the change of the number of skipped orbits  

    .. py:method:: on_count_changed(self)

        Handle the change of the count value  

    .. py:method:: on_wait_changed(self)

        Handle the change of the wait time  

    .. py:method:: on_build_spectrograms_changed(self)

        Handle the change of the build_spectrograms checkbox  

    .. py:method:: on_simulate_pilot_bunch_changed(self)

        Handle the change of the simulate_pilot_bunch checkbox  

    .. py:method:: on_trigger_skip_signals_changed(self, value)

        Handle change of trigger skip signal spinbox  

        :param int value: the value to set trigger_skip to (the number of trigger signals to skip between acquisitions  

    .. py:method:: on_trigger_method_changed(self)

        Handle change of trigger method.  

    .. py:method:: on_trigger_timeout_changed(self, value)

        Handle change of trigger timeout spinbox  

        :param int value: the value to set the trigger_timout to  

    .. py:method:: closeEvent(self, event)

        Event handler to handle the event of closing this window and gracefully delete resources and such  

        :param event: the event to handle (gets passed to by PyQt)  

.. py:class:: AcquireSettings(kcgw.KCGWidgets)

    This is the actual Acquire Settings Window.  

    .. py:method:: __init__(self, unique_id, parent=None)

        Initialise the acquire settings window  

        :param unique_id: the id for thiw widget  
        :param parent: parent object  

    .. py:method:: show_tab(self, board_id)

        Show the tab for the given board  

        :param board_id: the id of the board to show  

    .. py:method:: closeEvent(self, event)


.. py:method:: add_acquire_settings_widget(board_id=None)

    Add this widget to the gui.  
    This function will actually open the subwindow.  


.. py:method:: setValueSilent(key, value)

    Set values without notifying observers  

    :param key: the key  
    :param value: the value to set