More comments

Author: carterturn

blacs/plugins/virtual_device/__init__.py

@@ -56,13 +56,22 @@ def __init__(self, initial_settings):
 
         self.setup_complete = False
         self.close_event = threading.Event()
+        # If the virtual device starts after a device starts, it needs to connect its widgets.
+        # So we start a background thread to periodically check if we have any non-connected widgets and connect them.
         self.reconnect_thread = threading.Thread(target=self.reconnect, args=(self.close_event,))
         self.reconnect_thread.daemon = True
 
+        # If a tab (device) is restarted, it recreates its outputs.
+        # If the virtual device still has widgets referencing those outputs, they will fail.
+        # So, we need to disconnect them.
         self.tab_restart_receiver = lambda dn, s=self: self.disconnect_widgets(dn)
 
     @inmain_decorator(True)
     def connect_widgets(self):
+        '''
+        For each of our tabs, tell connect its widgets to outputs.
+        Also connect restart receivers so we can detect if new tabs start to close.
+        '''
         if not self.setup_complete:
             return
         for name, vd_tab in self.tab_dict.items():
@@ -73,6 +82,9 @@ def connect_widgets(self):
 
     @inmain_decorator(True)
     def disconnect_widgets(self, closing_device_name):
+        '''
+        For each of our tabs, disconnect it from closing_device_name
+        '''
         if not self.setup_complete:
             return
         self.BLACS['ui'].blacs.tablist[closing_device_name].disconnect_restart_receiver(self.tab_restart_receiver)
@@ -163,6 +175,12 @@ def _get_root_parent(item):
         return item
 
     def _get_child_outputs(self, conn_table, root_devs, dev_name, tab):
+        '''
+        Get all child outputs of a device.
+
+        This is more complex than simply accessing `child_list` for the device
+        as some devices have structures between themselves and their ultimate outputs.
+        '''
         AOs = []
         DOs = []
         DDSs = []
@@ -420,6 +438,9 @@ def on_edit_virtual_devices(self, *args, **kwargs):
         return
 
     def _encode_virtual_devices(self):
+        '''
+        Convert data in model to a simple dictionary that can be saved.
+        '''
         virtual_device_data = {}
         root = self.virtual_device_model.invisibleRootItem()
         for i in range(root.rowCount()):

blacs/plugins/virtual_device/virtual_device_tab.py

@@ -9,6 +9,10 @@
 class VirtualDeviceTab(PluginTab):
 
     def create_widgets(self, blacs_tablist, AOs, DOs, DDSs):
+        '''
+        This function sets up the tab, and should be called as soon as the plugin is otherwise ready.
+        Here, we create dictionaries of widgets (initially connecting them to outputs).
+        '''
         self._blacs_tablist = blacs_tablist
         self._AOs = {(AO[0], AO[1]): None for AO in AOs}
         self._DOs = {(DO[0], DO[1], DO[2]): None for DO in DOs}
@@ -28,7 +32,7 @@ def create_widgets(self, blacs_tablist, AOs, DOs, DDSs):
                 self._DOs[DO].setText('%s\n%s'%(DO[0]+'.'+orig_label[0], orig_label[1]))
                 self._DOs[DO].last_DO = None
 
-        dds_widgets = []
+        dds_widgets = [] # TODO
 
         if len(self._AOs) > 0:
             self.place_widget_group('Analog Outputs', [v for k, v in self._AOs.items()])
@@ -38,6 +42,10 @@ def create_widgets(self, blacs_tablist, AOs, DOs, DDSs):
         return
 
     def connect_widgets(self):
+        '''
+        For each of our widgets, check if it is connected to an output.
+        If not, connect it.
+        '''
         for AO in self._AOs.keys():
             if self._AOs[AO] is not None:
                 new_AO = self._blacs_tablist[AO[0]].get_channel(AO[1])
@@ -50,6 +58,10 @@ def connect_widgets(self):
                     self._DOs[DO].set_DO(new_DO)
 
     def disconnect_widgets(self, closing_device_name):
+        '''
+        For each of our widgets, check if it connects to an output in 'closing_device_name'.
+        If it is, disconnect it so that 'closing_device_name' can be safely closed.
+        '''
         for AO in self._AOs.keys():
             if AO[0] == closing_device_name:
                 self._AOs[AO].last_AO = self._AOs[AO].get_AO()