-                      r31b0c47
+                      r5062bbf
 class StateIterator(object):
     """
         Contains all saved state of a given page.
         Provide position of the current state of a page, the first save state
         and the last state for a given page.
         Allow easy undo or redo for a given page
+    Contains all saved state of a given page.
+    Provide position of the current state of a page, the first save state
+    and the last state for a given page.
+    Allow easy undo or redo for a given page
     """
     def __init__(self):
+        """
+        """
         self._current=0
     def __iter__(self):
+        """
+        """
         return self
     def first(self):
+        """
+        """
         self._current =0
         return self._current
     def next(self, max ):
+        """
+        """
         if self._current < max:
             self._current += 1
 …
     def previous(self):
+        """
+        """
         if self._current > 0:
             self._current = self._current -1
 …
     def currentPosition(self):
+        """
+        """
         return self._current
     def setPosition(self, value):
+        """
+        """
         if value >=0:
             self._current = int(value)
+class ListOfState(list):
+class ListOfState(list):
+    """
+    """
     def __init__(self, *args, **kw):
         list.__init__(self, *args, **kw)
 …
     def appendItem(self, x):
+        """
+        """
         self.append(x)
         self.iterator.setPosition(value= len(self)-1)
     def removeItem(self, x):
+        """
+        """
         self.iterator.previous()
         self.remove(x)
     def getPreviousItem(self):
+        """
+        """
         position = self.iterator.previous()
 …
     def getNextItem(self):
+        """
+        """
         position = self.iterator.next(max= len(self)-1)
         if position >= len(self):
 …
     def getCurrentItem(self):
+        """
+        """
         postion = self.iterator.currentPosition()
         if postion >= 0 and position < len(self):
 …
     def getCurrentPosition(self):
+        """
+        """
         return self.iterator.currentPosition()
 …
 class PageInfo(object):
     """
         this class contains the minimum numbers of data members
         a fitpage or model page need to be initialized.
+    this class contains the minimum numbers of data members
+    a fitpage or model page need to be initialized.
     """
     data = None
 …
                   event_owner=None, model_list_box=None, name=None):
         """
             Initialize data members
+        Initialize data members
         """
         self.data = data
 …
     """
+        FitPanel class contains fields allowing to fit  models and  data
+        @note: For Fit to be performed the user should check at least one parameter
+    FitPanel class contains fields allowing to fit  models and  data
+    :note: For Fit to be performed the user should check at least one parameter
         on fit Panel window.
 …
     def __init__(self, parent, *args, **kwargs):
+        """
+        """
         wx.aui.AuiNotebook.__init__(self, parent, -1,
                     style= wx.aui.AUI_NB_WINDOWLIST_BUTTON|
 …
     def set_state(self, state):
         """
             Restore state of the panel
+        Restore state of the panel
         """
         page_is_opened = False
 …
     def on_close_page(self, event):
         """
              close page and remove all references to the closed page
+        close page and remove all references to the closed page
         """
         nbr_page = self.GetPageCount()
 …
     def close_page_with_data(self, deleted_data):
         """
             close a fit page when its data is completely remove from the graph
+        close a fit page when its data is completely remove from the graph
         """
         if deleted_data is None:
 …
     def set_manager(self, manager):
         """
+             set panel manager
+             @param manager: instance of plugin fitting
+        set panel manager
+        :param manager: instance of plugin fitting
         """
         self.manager = manager
 …
     def set_owner(self,owner):
         """
+            set and owner for fitpanel
+            @param owner: the class responsible of plotting
+        set and owner for fitpanel
+        :param owner: the class responsible of plotting
         """
         self.event_owner = owner
 …
     def set_model_list(self, dict):
          """
+             copy a dictionary of model into its own dictionary
+             @param dict: dictionnary made of model name as key and model class
+         copy a dictionary of model into its own dictionary
+         :param dict: dictionnary made of model name as key and model class
              as value
          """
          self.model_list_box = dict
     def get_current_page(self):
         """
+            @return the current page selected
+        :return: the current page selected
         """
         return self.GetPage(self.GetSelection() )
 …
     def add_sim_page(self):
         """
             Add the simultaneous fit page
+        Add the simultaneous fit page
         """
         from simfitpage import SimultaneousFitPage
 …
     def get_page_info(self, data=None):
         """
             fill information required to add a page in the fit panel
+        fill information required to add a page in the fit panel
         """
         name = "Fit Page"
 …
     def add_empty_page(self):
         """
             add an empty page
+        add an empty page
         """
         page_info = self.get_page_info()
 …
     def add_page(self, page_info):
         """
             add a new page
+        add a new page
         """
         from fitpage import FitPage
 …
     def change_page_content(self, data, index):
         """
             replace the contains of an existing page
+        replace the contains of an existing page
         """
         page_info = self.get_page_info(data=data)
 …
     def replace_page(self, index, page_info, type):
         """
             replace an existing page
+        replace an existing page
         """
         self.DeletePage(index)
 …
     def add_fit_page(self, data, reset=False):
         """
+            Add a fitting page on the notebook contained by fitpanel
+            @param data: data to fit
+            @return panel : page just added for further used. is used by fitting module
+        Add a fitting page on the notebook contained by fitpanel
+        :param data: data to fit
+        :return panel : page just added for further used. is used by fitting module
         """
         if data is None:
 …
     def  _onGetstate(self, event):
         """
             copy the state of a page
+        copy the state of a page
         """
         page= event.page
 …
     def _onUndo(self, event ):
         """
             return the previous state of a given page is available
+        return the previous state of a given page is available
         """
         page = event.page
 …
     def _onRedo(self, event):
         """
             return the next state available
+        return the next state available
         """
         page = event.page
 …
     def _close_helper(self, selected_page):
         """
             Delete the given page from the notebook
+        Delete the given page from the notebook
         """
         #remove hint page

Note: See TracChangeset for help on using the changeset viewer.

SasView

Changeset 5062bbf in sasview for sansview/perspectives/fitting/fitpanel.py

Legend:

sansview/perspectives/fitting/fitpanel.py

Download in other formats: