KaptureControlGui/KCG/Documentation/source/Dev/code/base/leftbar.rst

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


.. module:: leftbar


.. _leftbar:



Module leftbar
==============



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

    Specific Part for each board  

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

        This creates the information part for board with id board_id.  
        This is used to be able to create a variable number of board information areas.  

        :param board_id: the id of the board  

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

    Widget to show below the plot list.  
    Show certain information.  
    Provide Start Acquisition button and settings.  

    .. py:method:: __init__(self)


    .. py:method:: toggle_acquisition(self)

        Turn acquisition on/off. This gets the information about which board to use by checking state of the checkboxes.  


    .. py:method:: update_acq_tickboxes(self)

        If at least one checkbox is checked, set all checkboxes with other state (acquiring or not)  
        to disabled. This prevents the user to start with one board and stop with the other simultaneously.  
        TODO: add option in settings to allow the now eliminated behaviour  

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

        This is called when a acquisition is stopped.  
        (has to be registered in Callbacks under 'acquisition_stopped'  

        :param board_id: id of the board  

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

        This is called when a acquisition is started.  
        (has to be registered in Callbacks under 'acquisition_started'  

        :param board_id: id of the board  

    .. py:method:: do_log_w_comment(self)

        Function to handle logging with comments  

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

        Function that creates the context menu for the log buttons  

        :param event: (QEvent) the event  

    .. py:method:: update_consistency(self, status)

        Set consistency indicator  

        :param status: True if consistent, False if inconsistent, None is nothing  

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

    Left bar in the main view of the gui.  
    Shows plot list and acquisition and info panel  

    .. py:method:: __init__(self, parent)


    .. py:method:: initUI(self)

        Initialise the UI  

    .. py:method:: _generate_menu(self, menu, item)

        Generate the right click menu  

        :param menu: the menu to add the entries to  
        :param item: the item that was clicked on  

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

        Gets called when right mouse button is clicked  

        :param event: the event that causes the call of this function  

    .. py:method:: plot_clicked(self, item, i)

        Function to handle when a plot item is clicked.  

        :param item: what item is clicked  
        :param i: what column  

    .. py:method:: add_plot_tree(self, text=False, unique_id=None, datatype=None)

        Add a top node to the plot list.  

        :param text: (str) text to be displayed in the plot list  
        :param unique_id: (int) unique id of this top node  
        :param datatype: (int) live or data from file  

    .. py:method:: read_data(self, d_type, uid, file_name)

        Reads datafile  

        :param d_type: FILE or LIVE - type of datasource  
        :param uid: unique id for the treeelement  
        :param file_name: filename if type is FILE  

    .. py:method:: add_plot_node(self, board_id=None, text=False, unique_id=None, d_type=None, datatype=None)

        Actually open a new plot window.  

        :param board_id: the id of the board to which the plot corresponds  
        :param text: (str) text that is displayed in the plot list  
        :param unique_id: (int) unique id of this plot window  
        :param d_type: (int) type of this plot window  
        :param datatype: (int) live or data from file  

    .. py:method:: remove_plot(self, unique_id, silent=False, close_plot_window=False)

        Removes a plot from the plot list.  

        :param unique_id: (int) the unique id of the plot to remove  
        :param silent: (bool) Ask to close the plot source node in the list if the last plot window is closed  
                        (if False the source node will not be closed)  
        :param close_plot_window: (bool) close the corresponding plot window  

    .. py:method:: remove_plot_tree(self, unique_id, silent=False)

        Remove the top node from the plot list  

        :param unique_id: (int) the id of the top node  
        :param silent: (bool) ask to close even if corresponding plot windows are open  

    .. py:method:: update_plot(self, uid, b_type, add)

        Updates the plot list when the type of a plot window changes  

        :param uid: (int) unique id of the plot window to update  
        :param b_type: (int) type of that plot window  
        :param str add: the add, board and additional text to update  

    .. py:method:: handle_dialog(self, value, diag=None,)

        Function that handles the return of the dialog that asks for live or data from file  

        :param value: (int) the value of the pressed button in the dialog  
        :param diag: (QDialog) the dialog that is to be closed (optional)  

    .. py:method:: add_plot(self, d_type=None)

        Handles the creation of a plot.  
        Also shows the dialog that asks for the data source.  

        :param d_type: the type of the plot to add