Merge branch 'i69-covert_plot_functions_items_to_dict' into 'master'

convert plot_func_names.plot_functions's items to dict to be more descriptive

See merge request !210

sohstationviewer/view/db_config/param_dialog.py

@@ -28,7 +28,7 @@ class ParamDialog(UiDBInfoDialog):
 
         self.require_valuecolors_plottypes = [
             p for p in plot_functions.keys()
-            if 'ValueColors' in plot_functions[p][0]]
+            if 'ValueColors' in plot_functions[p]['description']]
         super().__init__(
             parent,
             ['No.', 'Param', 'Plot Type', 'ValueColors', 'Height    '],

sohstationviewer/view/db_config/plot_type_dialog.py

@@ -32,4 +32,5 @@ class PlotTypeDialog(UiDBInfoDialog):
         """
         Get list of data to fill self.data_table_widgets' content
         """
-        return [[key, val[0]] for key, val in plot_functions.items()]
+        return [[key, val['description']]
+                for key, val in plot_functions.items()]

sohstationviewer/view/plotting/state_of_health_widget.py

@@ -68,7 +68,8 @@ class SOHWidget(MultiThreadedPlottingWidget):
             return
         chan_db_info = c_data['chan_db_info']
         plot_type = chan_db_info['plotType']
-        ax = getattr(self.plotting, plot_functions[plot_type][1])(
+        ax = getattr(
+            self.plotting, plot_functions[plot_type]['plot_function'])(
             c_data, chan_db_info, chan_id)
         c_data['ax'] = ax
         ax.chan = chan_id

sohstationviewer/view/plotting/waveform_dialog.py

@@ -49,7 +49,8 @@ class WaveformWidget(MultiThreadedPlottingWidget):
         plot_type = chan_db_info['plotType']
 
         # refer to doc string for mass_pos_data to know the reason for 'ax_wf'
-        ax = getattr(self.plotting, plot_functions[plot_type][1])(
+        ax = getattr(
+            self.plotting, plot_functions[plot_type]['plot_function'])(
             c_data, chan_db_info, chan_id)
         c_data['ax_wf'] = ax
         ax.chan = chan_id

sohstationviewer/view/util/plot_func_names.py

 plot_functions = {
-        'linesDots': (
-            "Lines, one color dots. Dot or line/color mapping defined by "
-            "ValueColors with available colors: RYGMCW.\n"
-            "Ex: L:G|D:W\n"
-            "  means \tLines are plotted with color G\n"
-            "\tDots are plotted with color W\n"
-            "If D is not defined, dots won't be displayed.\n"
-            "If L is not defined, lines will be plotted with color G",
-            "plot_lines_dots"),
-        'linesSRate': (
-            "Lines, one color dots, bitweight info. ",
-            "plot_lines_s_rate"),
-        'linesMasspos': (
-            "multi-line mass position, multi-color dots. ",
-            "plot_lines_mass_pos"),
-        'triColorLines': (
-            "Three lines with three different colors for values -1, 0, 1.",
-            "plot_tri_colors"),
-        'dotForTime': (
-            "Dots according to timestamp.\n"
-            "Color defined by ValueColors with available colors: RYGMCW.\n"
-            "Ex: G",
-            "plot_time_dots"),
-        'multiColorDotsEqualOnUpperBound': (
-            ("Multicolor dots in center with value/colors mapping defined by "
-             "ValueColors with available colors: RYGMCW.\n"
-             "Value from low to high.\n"
-             "Ex: *:W  in which all values represent by white dots.\n"
-             "Ex: -1:_|0:R|2.3:Y|+2.3:G\n"
-             "  in which \tvalue <= -1  => not plot\n"
-             "\tvalue <= 0   => plot with R color\n"
-             "\tvalue <= 2.3 => plot with Y color\n"
-             "\tvalue > 2.3  => plot with G color\n"),
-            "plot_multi_color_dots_equal_on_upper_bound"
-        ),
-        'multiColorDotsEqualOnLowerBound': (
-            ("Multicolor dots in center with value/colors mapping defined by "
-             "ValueColors with available colors: RYGMCW.\n"
-             "Value from low to high.\n"
-             "Ex: 3.:R|3.3:Y|=3.3:G\n"
-             "  in which"
-             "\tvalue < 3.   => plot with R color\n"
-             "\t3 <= value < 3.3 => plot with Y color\n"
-             "\tvalue = 3.3  => plot with G color\n"),
-            "plot_multi_color_dots_equal_on_lower_bound"
-        ),
-        'upDownDots': (
-            ("Show data with 2 different values: first down/ second up. "
-             "Colors defined by ValueColors.\nEx: 1:R|0:Y"),
-            'plot_up_down_dots'
-        )
+        'linesDots': {
+            "description": (
+                "Lines, one color dots. Dot or line/color mapping defined by "
+                "ValueColors with available colors: RYGMCW.\n"
+                "Ex: L:G|D:W\n"
+                "  means \tLines are plotted with color G\n"
+                "\tDots are plotted with color W\n"
+                "If D is not defined, dots won't be displayed.\n"
+                "If L is not defined, lines will be plotted with color G"),
+            "plot_function": "plot_lines_dots"
+        },
+        'linesSRate': {
+            "description": "Lines, one color dots, bitweight info. ",
+            "plot_function": "plot_lines_s_rate"
+        },
+        'linesMasspos': {
+            "description": "multi-line mass position, multi-color dots. ",
+            "plot_function": "plot_lines_mass_pos"
+        },
+        'triColorLines': {
+            "description": "Three lines with three different colors for "
+                           "values -1, 0, 1.",
+            "plot_function": "plot_tri_colors"
+        },
+        'dotForTime': {
+            "description": (
+                "Dots according to timestamp.\n"
+                "Color defined by ValueColors with available colors: RYGMCW.\n"
+                "Ex: G"),
+            "plot_function": "plot_time_dots"
+        },
+        'multiColorDotsEqualOnUpperBound': {
+            "description": (
+                "Multicolor dots in center with value/colors mapping defined "
+                "by ValueColors with available colors: RYGMCW.\n"
+                "Value from low to high.\n"
+                "Ex: *:W  in which all values represent by white dots.\n"
+                "Ex: -1:_|0:R|2.3:Y|+2.3:G\n"
+                "  in which \tvalue <= -1  => not plot\n"
+                "\tvalue <= 0   => plot with R color\n"
+                "\t0 < value <= 2.3 => plot with Y color\n"
+                "\t2.3 < value  => plot with G color\n"),
+            "plot_function": "plot_multi_color_dots_equal_on_upper_bound"
+        },
+        'multiColorDotsEqualOnLowerBound': {
+            "description": (
+                "Multicolor dots in center with value/colors mapping defined "
+                "by ValueColors with available colors: RYGMCW.\n"
+                "Value from low to high.\n"
+                "Ex: 3.:R|3.3:Y|=3.3:G\n"
+                "  in which"
+                "\tvalue < 3.   => plot with R color\n"
+                "\t3. <= value < 3.3 => plot with Y color\n"
+                "\tvalue = 3.3  => plot with G color\n"),
+            "plot_function": "plot_multi_color_dots_equal_on_lower_bound"
+        },
+        'upDownDots': {
+            "description": (
+                "Show data with 2 different values: first down/ second up. "
+                "Colors defined by ValueColors.\nEx: 1:R|0:Y"),
+            "plot_function": 'plot_up_down_dots'
+        }
     }