Ticket3002 refactor and extend caen scripts

base/uk.ac.stfc.isis.ibex.opis/resources/HV/HVMonitorSummaryDisplay.opi

@@ -504,7 +504,7 @@ On/Off</text>
     <auto_size>false</auto_size>
     <rotation_angle>0.0</rotation_angle>
     <scripts>
-      <path pathString="Scripts/DisplaySummary.js" checkConnect="true" sfe="false" seoe="false">
+      <path pathString="Scripts/DisplaySummary.py" checkConnect="true" sfe="false" seoe="false">
         <pv trig="true">$(P)CAEN:CHANLIST</pv>
       </path>
     </scripts>

base/uk.ac.stfc.isis.ibex.opis/resources/HV/Scripts/ChannelUtilities.py

@@ -0,0 +1,137 @@
+from org.csstudio.opibuilder.scriptUtil import PVUtil
+from org.csstudio.opibuilder.scriptUtil import ConsoleUtil
+
+
+def get_available_channels(crate_name_pvs, this_display,
+                           get_string_from_pv=PVUtil.getString, log=ConsoleUtil.writeError):
+    """
+    Generator for the available Caen channels
+
+    Args:
+        crate_name_pvs: The PVs containing the names of the crates
+        this_display: The display that contains the macros for the maximum number of crates, slots and channels
+        get_string_from_pv: Method used to get strings from PVs
+        log: Method to send strings to the logs
+
+    Yields:
+        A tuple of crate (string), slot (int), channel (int)
+    """
+    for crate_name_pv in crate_name_pvs:
+        try:
+            crate = get_string_from_pv(crate_name_pv)
+        except Exception, e:
+            log("Unable to get crate name for PV: " + crate_name_pv + " , error: " + str(e))
+            continue
+
+        if len(crate) == 0:
+            continue
+
+        for slot in range(get_max_slots(this_display)):
+            for channel in range(get_max_channels(this_display)):
+                yield crate, slot, channel
+
+
+def get_summary_channels(channel_list_pv, get_string_from_pv=PVUtil.getString, log=ConsoleUtil.writeError):
+    """
+    Gets the list of channels from the HVCaen.
+
+    Args:
+        channel_list_pv: The PV containing the list of channels.
+        get_string_from_pv: Function for extracting a string from a named PV
+        log: Function accepting a string that is written to a log
+
+    Returns:
+        A list of available channels, or an empty list if getting the channels fails.
+    """
+
+    def channel_formatter(channel):
+        formatted_channel = channel.replace(" ", "")
+        if formatted_channel.endswith(','):
+            formatted_channel = formatted_channel[:-1]
+        return formatted_channel
+
+    channels = list()
+    try:
+        if channel_list_pv.getValue().getData().size() > 0:  # default method throws uncaught java exception if empty
+    	    channels = [channel_formatter(chan) for chan in get_string_from_pv(channel_list_pv).split(' ')]
+    except Exception, e:  # Jython slightly different to standard Python
+        log("Unable to get channel list for HVCaen: " + str(e))  # Jython str has no 'format'
+    return channels
+
+def _get_max(this_display, macro, default_value, upper_limit=None):
+    """
+
+    Args:
+        this_display: The display. The returned value should be available via a macro.
+        macro: The macro containing the value
+        default_value: The value to use if the macro isn't specified
+        upper_limit: The absolute maximum value the property can take
+        log: Where to send messages
+
+    Returns:
+        The value of the macro
+    """
+    max_value = this_display.getPropertyValue("macros").getMacrosMap().get(macro)
+
+    try:
+        max_value = int(max_value)
+    except TypeError:
+        max_value = default_value   
+
+    if max_value is None:
+        max_value = default_value
+
+    if upper_limit is not None:
+        max_value = min(max_value, upper_limit)
+
+    return max_value
+
+
+def get_max_crates(this_display):
+    """
+    The absolute maximum value is 15, determined by the limitations of EPICS MMBO records.
+
+    Args:
+        this_display: The display. The returned value should be available via a macro.
+
+    Returns:
+        The maximum number of crates supported by the OPI
+    """
+    return _get_max(this_display, "MAX_CRATES", 2, 15)
+
+
+def get_max_slots(this_display):
+    """
+    Args:
+        this_display: The display. The returned value should be available via a macro.
+
+    Returns:
+        The maximum number of slots supported by the OPI
+    """
+    return _get_max(this_display, "MAX_SLOTS", 5)
+
+
+def get_max_channels(this_display):
+    """
+    Args:
+        this_display: The display. The returned value should be available via a macro.
+
+    Returns:
+        The maximum number of channels supported by the OPI
+    """
+    return _get_max(this_display, "MAX_CHANNELS", 10)
+
+
+def get_channel_pv_name(crate, slot, channel):
+    """
+    Gets the PV name for a given channel
+
+    Args:
+        crate: The name of the crate
+        slot: The slot number
+        channel: The channel number
+
+    Returns:
+        The PV name for accessing the given channel
+    """
+    return crate + ":" + str(slot) + ":" + str(channel)

base/uk.ac.stfc.isis.ibex.opis/resources/HV/Scripts/DisplayChannels.py

@@ -0,0 +1,33 @@
+from ChannelUtilities import get_summary_channels, get_available_channels, get_max_crates, get_channel_pv_name
+from OPIUtilities import get_cleared_group_widget, create_channel_widget_model
+
+
+def add_channel_widgets(this_display, this_pvs):
+    """
+    Clears the current group box displaying the available channels and repopulates it with the latest
+    available channels.
+
+    Args:
+        this_display: The display that has called this script. Used to control modification of global CSS variables
+        this_pvs: PVs passed to the script by CSS. Used to control modification of global CSS variables
+
+    Returns:
+        None
+    """
+    channel_selector_widget = get_cleared_group_widget(this_display)
+    current_included_channels = get_summary_channels(this_pvs[1])
+
+    for crate, slot, channel in get_available_channels(this_pvs[2:2+get_max_crates(this_display)], this_display):
+        channel_selector_widget.addChildToBottom(
+            create_channel_widget_model(get_channel_pv_name(crate, slot, channel), False))
+
+        # Check if the channel is in in the list, and check the box if it is
+        if get_channel_pv_name(crate, slot, channel) in current_included_channels:
+            channel_selector_widget.getChildren()[-1].getChild("Include").setValue(1)
+
+
+if __name__ == "__main__":
+    # pv[0] = $(P)CAEN:crates, triggered
+    # pv[1] = $(P)CAEN:CHANLIST, triggered
+    # pv[2-17] = $(P)CAEN:crates.[XX]ST
+    add_channel_widgets(display, pvs)

base/uk.ac.stfc.isis.ibex.opis/resources/HV/Scripts/DisplaySummary.py

@@ -0,0 +1,23 @@
+from ChannelUtilities import get_summary_channels
+from OPIUtilities import get_cleared_group_widget, create_channel_widget_model
+
+
+def create_channels_summary(this_display, this_pvs):
+    """
+    Clears the summary widget and repopulates it with the widgets for the current channel summary.
+
+    Args:
+        this_display: The display that has called this script. Used to control modification of global CSS variables
+        this_pvs: PVs passed to the script by CSS. Used to control modification of global CSS variables
+
+    Returns:
+        None
+    """
+    group = get_cleared_group_widget(this_display)
+    for chan in get_summary_channels(this_pvs[0]):
+        group.addChildToBottom(create_channel_widget_model(chan, True))
+
+
+if __name__ == "__main__":
+    # pv[0] = $(P)CAEN:CHANLIST
+    create_channels_summary(display, pvs)

base/uk.ac.stfc.isis.ibex.opis/resources/HV/Scripts/OPIUtilities.py

@@ -0,0 +1,39 @@
+from org.csstudio.opibuilder.scriptUtil import WidgetUtil
+
+
+def get_cleared_group_widget(this_display):
+    """
+    Gets the widget called 'group' and clears its children.
+
+    Args:
+        this_display: The CSS display component
+
+    Returns:
+        The group widget having had its children removed
+
+    """
+    group_widget = this_display.getWidget('group')
+    group_widget.removeAllChildren()
+    return group_widget
+
+
+def create_channel_widget_model(name, is_summary):
+    """
+    Creates a widget to display information about a given channel
+
+    Args:
+        name: Name of the channel
+        is_summary: Is this a summary? If so use the summary OPI template, else use the maintenance template
+
+    Returns:
+        The target widget
+    """
+    model = WidgetUtil.createWidgetModel("org.csstudio.opibuilder.widgets.linkingContainer")
+    model.setPropertyValue("opi_file",
+                           "HVChannelMonitorSummary.opi" if is_summary else "HVChannelSummaryMaintenance.opi")
+    model.setPropertyValue("auto_size", "true")
+    model.setPropertyValue("zoom_to_fit", "false")
+    model.setPropertyValue("border_style", 0)
+    model.setPropertyValue("name", name)
+    model.addMacro("SEL", name)
+    return model