singleread.rst 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. .. This is a autogemerated documentation from python docstrings. It was generated using DStrings2Doc.
  2. .. module:: singleread
  3. .. _singleread:
  4. Module singleread
  5. =================
  6. This Module is the SingleRead window.
  7. .. py:class:: SingleReadWidget(kcgw.KCGWidgets)
  8. The actual single read window.
  9. .. py:method:: __init__(self, unique_id, parent=None)
  10. Initialise the single read widget
  11. :param unique_id: the id for this widget
  12. :param parent: parent object
  13. .. py:method:: on_single_read(self)
  14. Perform a single read on all boards which ticks are set
  15. .. py:method:: on_continuous_read(self, state, board_id)
  16. Toggle function to toggle continuous read when the corresponding button is pressed.
  17. :param bool state: True to activate and False to deactivate continuous read for board_id
  18. :param int? board_id: the id of the board to take action with
  19. .. py:method:: set_interval(self)
  20. Set the interval between reads
  21. .. py:method:: closeEvent(self, event)
  22. Event handler to handle the event of closing this window and gracefully delete ids and such
  23. :param event: the event to process (gets passed by PyQt)
  24. .. py:method:: add_single_read_widget()
  25. Add this widget to the gui.
  26. This function will actually open the subwindow.