Changeset fa412df in sasview for src/sas/sasgui/guiframe

Timestamp:

Sep 6, 2018 10:58:01 AM (6 years ago)

Author:

krzywon

Branches:

master, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, unittest-saveload

Children:

d0ce666f

Parents:

ec4b19c

Message:

Simplify calling image handler and add documentation.

File:

• src/sas/sasgui/guiframe/report_image_handler.py (modified) (4 diffs)

src/sas/sasgui/guiframe/report_image_handler.py

@@ -3 +3 @@
 
 class ReportImageHandler:
-
+    # Singleton class that manages all report plot images
+    # To call the handler, call the static method set_figs
 
     class _ReportImageHandler:
@@ -14 +15 @@
 
         def set_figs(self, figs, bitmaps, perspective):
+            """
+            Save figures and images to memory and return refernces
+            :param figs: A list of matplotlib Figures
+            :param bitmaps: A list of bitmaps
+            :param perspective: A String with the perspective name
+            :return: A tuple of a list of Figures and a list of memory refs
+            """
             imgs = []
             refs = []
@@ -34 +42 @@
 
         def create_unique_name(self, perspective, index=None):
+            """
+            Create a unique key for each item in memory
+            :param perspective: The perspective name as a string
+            :param index: The base index used for incrementing the name
+            :return: A unique file name not currently in use
+            """
             if not index:
                 index = len(self.indices)
@@ -43 +57 @@
             return name
 
-
     instance = None
 
-    def __init__(self):
+    @staticmethod
+    def set_figs(figs, bitmaps, perspective):
         if not ReportImageHandler.instance:
             ReportImageHandler.instance = ReportImageHandler._ReportImageHandler()
+        return ReportImageHandler.instance.set_figs(figs, bitmaps, perspective)