KaptureControlGui/KCG/Documentation/source/Dev/code/base/backend/board/board_config.rst

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


.. module:: board_config


.. _board_config:



Module board_config
===================


Configuration for each board  

.. py:class:: BoardConfiguration(QtGui.QWidget)

    The Main configuration class for boards.  

    .. py:method:: __init__(self, identifier, config_file=None)


    .. py:method:: _set_defaults(self)

        Set default values  

    .. py:method:: set_default_observers(self)

        Set observers that are always used  

    .. py:method:: notify_all_observers(self)

        Notify all observers not only the ones that are affected by a change  

    .. py:method:: load_config(self, filename)

        Load a config from a file  

        :param filename: the configuration file  

    .. py:method:: save_config(self, filename)

        Save the current configuration to a file  

        :param filename: the file to write to  

    .. py:method:: get(self, key)

        Get the configuration value for key  

        :param key: the key to get the value for  
        :return: the value of the configuration for key  

    .. py:method:: dump(self)

        Dump all configuration values  

        :return: all configuration values as list  

    .. py:method:: update(self, key, value)

        Update the value for key in the configuration  

        :param key: the key to update  
        :param value: the value to set the configuration for key to  

    .. py:method:: updateSilent(self, key, value)

        Update the configuration without notifying observers  

        :param key: the key to updae  
        :param value: the value to set the configuration of key to  

    .. py:method:: observe(self, who, callback, key)

        Register an observer. (A callback that is called when the according configuration value changes)  

        :param who: who is observing  
        :param callback: the callback to call on change of the configuration value  
        :param key: the key to observe  

    .. py:method:: observe_all(self, callback)

        Register a observer that is called when any key changes  

        :param callback: the callback to register  

    .. py:method:: unobserve(self, who, key=None)

        Remove an observer  

        :param who: the observing entity  
        :param key: the key to remove it from  

    .. py:method:: unobserve_all_observer(self, callback)

        Unobserve an observer that observes all keys.  

        :param callback: the callback to unobserve  

    .. py:method:: _notify_observers_receiver(self, key, value)

        The pyqt signal slot for notifications of observers  

        :param key: the key that changed  
        :param value: the new value  

    .. py:method:: _notify_observers(self, key, value)

        Notify observers. This emits a pyqt signal to make it thread save  

        :param key: the key that changed  
        :param value: the new value  

    .. py:method:: make_uint(self, value, maximum, name=None)

        Convert a value to an uint  

        :param value: the value  
        :param maximum: the maximum of the returned value  
        :param name: the name of this value  
        :return: the converted value  

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

        Set the fpga_delays on the board  

        :param value: the value to set the delays to  

    .. py:method:: set_chip_delay(self, adcs, values)

        Set the chip_delays on the board  

        :param adcs: the adcs to set the delays for  
        :param values: the value to set the delays to  

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

        Set the track and hold delay on the board  

        :param value: the value to set the delay to  

    .. py:method:: set_adc_delay(self, adc, value)

        Set the adc delay for the given adc on the board  

        :param adc: the adc to change the delay for  
        :param value: the value to set the delay to  

    .. py:method:: set_delay(self, n, ignore_seperate_delay=False)

        Set delays  

        :param n: ?  
        :param ignore_seperate_delay: ignore the setting of a seperate delay for adc 1  

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

        Set the flag to write Header to files when acquiring.  

        :param state: True to enabling header and False to disable  

    .. py:method:: read_from_board(self)

        Read values from board and update them in the configuration (Mainly used for skip init functionality)