Merge pull request #2276 from ControlSystemStudio/refresh_databrowser

Add Data browser 'refresh' to 'stripchart' and clear live samples

Author: kasemir

app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/Controller.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010-2021 Oak Ridge National Laboratory.
+ * Copyright (c) 2010-2022 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -591,6 +591,20 @@ private void doUpdate()
         }
     }
 
+    /** Clear live samples, re-fetch archived data */
+    public void refresh()
+    {
+        // Clear live data buffer of PVs
+        for (ModelItem item : model.getItems())
+            if (item instanceof PVItem)
+            {
+                final PVItem pv = (PVItem) item;
+                pv.getSamples().clear();
+            }
+        // Re-fetch archived data
+        scheduleArchiveRetrieval();
+    }
+
     /** Stop scrolling and model items
      *  @throws IllegalStateException when not running
      */

app/databrowser/src/main/java/org/csstudio/trends/databrowser3/ui/Perspective.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2018-2020 Oak Ridge National Laboratory.
+ * Copyright (c) 2018-2022 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -185,7 +185,7 @@ private void createContextMenu()
             showBottomTab(waveform_tab);
         });
         final MenuItem refresh = new MenuItem(Messages.Refresh, Activator.getIcon("refresh_remote"));
-        refresh.setOnAction(event -> controller.scheduleArchiveRetrieval());
+        refresh.setOnAction(event -> controller.refresh());
 
         final ContextMenu menu = new ContextMenu();
         final ObservableList<MenuItem> items = menu.getItems();

app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/plots/DataBrowserWidget.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011-2020 Oak Ridge National Laboratory.
+ * Copyright (c) 2011-2022 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -96,12 +96,17 @@ public boolean configureFromXML(final ModelReader model_reader, final Widget wid
     public static final WidgetPropertyDescriptor<Instant> runtimePropOpenFull =
             CommonWidgetProperties.newRuntimeEvent("open_full", "Open Full Data Browser");
 
+    /** 'refresh_plot' */
+    public static final WidgetPropertyDescriptor<Instant> runtimePropRefreshPlot =
+            CommonWidgetProperties.newRuntimeEvent("refresh_plot", "Refresh Plot");
+
     private volatile WidgetProperty<Boolean> show_toolbar;
     private volatile WidgetProperty<String> file;
     private volatile RuntimeEventProperty configure;
     private volatile WidgetProperty<String> selection_value_pv;
     private volatile WidgetProperty<VType> selection_value;
     private volatile RuntimeEventProperty open_full;
+    private volatile RuntimeEventProperty refresh_plot;
 
     /** Constructor */
     public DataBrowserWidget()
@@ -119,6 +124,7 @@ protected void defineProperties(final List<WidgetProperty<?>> properties)
         properties.add(selection_value_pv = propSelectionValuePV.createProperty(this, ""));
         properties.add(selection_value = propSelectionValue.createProperty(this, null));
         properties.add(open_full = (RuntimeEventProperty) runtimePropOpenFull.createProperty(this, null));
+        properties.add(refresh_plot = (RuntimeEventProperty) runtimePropRefreshPlot.createProperty(this, null));
     }
 
     @Override
@@ -189,4 +195,10 @@ public RuntimeEventProperty runtimePropOpenFull()
     {
         return open_full;
     }
+
+    /** @return 'refresh_plot' property */
+    public RuntimeEventProperty runtimePropRefreshPlot()
+    {
+        return refresh_plot;
+    }
 }

app/display/model/src/main/java/org/csstudio/display/builder/model/widgets/plots/StripchartWidget.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019 Oak Ridge National Laboratory.
+ * Copyright (c) 2019-2022 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -436,6 +436,7 @@ private boolean handleLegacyTraces(final ModelReader model_reader, final Stripch
     private volatile ArrayWidgetProperty<TraceWidgetProperty> traces;
     private volatile RuntimeEventProperty configure;
     private volatile RuntimeEventProperty open_full;
+    private volatile RuntimeEventProperty refresh_plot;
 
     /** Constructor */
     public StripchartWidget()
@@ -467,6 +468,7 @@ protected void defineProperties(final List<WidgetProperty<?>> properties)
         properties.add(traces = propTraces.createProperty(this, Arrays.asList(new TraceWidgetProperty(this, 0))));
         properties.add(configure = (RuntimeEventProperty) runtimePropConfigure.createProperty(this, null));
         properties.add(open_full = (RuntimeEventProperty) DataBrowserWidget.runtimePropOpenFull.createProperty(this, null));
+        properties.add(refresh_plot = (RuntimeEventProperty) DataBrowserWidget.runtimePropRefreshPlot.createProperty(this, null));
     }
 
     @Override
@@ -578,4 +580,10 @@ public RuntimeEventProperty runtimePropOpenDataBrowser()
     {
         return open_full;
     }
+
+    /** @return 'refresh_plot' property */
+    public RuntimeEventProperty runtimePropRefreshPlot()
+    {
+        return refresh_plot;
+    }
 }

app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/widgets/plots/DataBrowserRepresentation.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2011-2018 Oak Ridge National Laboratory.
+ * Copyright (c) 2011-2022 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -81,6 +81,10 @@ public class DataBrowserRepresentation extends RegionBaseRepresentation<Pane, Da
      */
     private volatile Controller controller;
 
+    private final WidgetPropertyListener<Instant> config_dialog_listener = (p, o, n) -> plot.getPlot().showConfigurationDialog();
+    private final WidgetPropertyListener<Instant> open_databrowser_listener = (p, o, n) ->
+        DataBrowserRepresentation.openFullDataBrowser(model, model_widget.getMacrosOrProperties(), model_widget.propShowToolbar().getValue());
+    private final WidgetPropertyListener<Instant> refresh_plot_listener = (p, o, n) -> controller.refresh();
 
     /** Listener to model's selected sample, updates widget.propSelectionValue() */
     private class ModelSampleSelectionListener implements ModelListener
@@ -162,9 +166,9 @@ protected void registerListeners()
 
         if (! toolkit.isEditMode())
         {
-            model_widget.runtimePropConfigure().addPropertyListener((p, o, n) -> plot.getPlot().showConfigurationDialog());
-            model_widget.runtimePropOpenFull().addPropertyListener((p, o, n) ->
-                openFullDataBrowser(model, model_widget.getMacrosOrProperties(), model_widget.propShowToolbar().getValue()));
+            model_widget.runtimePropConfigure().addPropertyListener(config_dialog_listener);
+            model_widget.runtimePropOpenFull().addPropertyListener(open_databrowser_listener);
+            model_widget.runtimePropRefreshPlot().addPropertyListener(refresh_plot_listener);
 
             // Track selected sample?
             // 'selection_value_pv' must be set when runtime starts,
@@ -181,6 +185,14 @@ protected void unregisterListeners()
         model_widget.propHeight().removePropertyListener(sizeChangedListener);
         model_widget.propShowToolbar().removePropertyListener(optsChangedListener);
         model_widget.propFile().removePropertyListener(fileChangedListener);
+
+        if (! toolkit.isEditMode())
+        {
+            model_widget.runtimePropConfigure().removePropertyListener(config_dialog_listener);
+            model_widget.runtimePropOpenFull().removePropertyListener(open_databrowser_listener);
+            model_widget.runtimePropRefreshPlot().removePropertyListener(refresh_plot_listener);
+        }
+
         super.unregisterListeners();
     }
 

app/display/representation-javafx/src/main/java/org/csstudio/display/builder/representation/javafx/widgets/plots/StripchartRepresentation.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019 Oak Ridge National Laboratory.
+ * Copyright (c) 2019-2022 Oak Ridge National Laboratory.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -72,8 +72,9 @@ public class StripchartRepresentation extends RegionBaseRepresentation<Pane, Str
     private final WidgetPropertyListener<Instant> config_dialog_listener = (p, o, n) -> plot.getPlot().showConfigurationDialog();
     private final WidgetPropertyListener<Instant> open_databrowser_listener = (p, o, n) ->
         DataBrowserRepresentation.openFullDataBrowser(model, model_widget.getMacrosOrProperties(), model_widget.propToolbar().getValue());
+    private final WidgetPropertyListener<Instant> refresh_plot_listener = (p, o, n) -> controller.refresh();
 
-
+    
     @Override
     protected Pane createJFXNode() throws Exception
     {
@@ -124,6 +125,7 @@ protected void registerListeners()
         {
             model_widget.runtimePropConfigure().addPropertyListener(config_dialog_listener);
             model_widget.runtimePropOpenDataBrowser().addPropertyListener(open_databrowser_listener);
+            model_widget.runtimePropRefreshPlot().addPropertyListener(refresh_plot_listener);
         }
 
         // Initial update
@@ -153,6 +155,7 @@ protected void unregisterListeners()
         {
             model_widget.runtimePropConfigure().removePropertyListener(config_dialog_listener);
             model_widget.runtimePropOpenDataBrowser().removePropertyListener(open_databrowser_listener);
+            model_widget.runtimePropRefreshPlot().removePropertyListener(refresh_plot_listener);
         }
 
         super.unregisterListeners();
@@ -318,6 +321,7 @@ private void updateModel()
             item.setLineWidth(trace.traceWidth().getValue());
             item.setPointType(XYPlotRepresentation.map(trace.tracePointType().getValue()));
             item.setPointSize(trace.tracePointSize().getValue());
+            item.useDefaultArchiveDataSources();
             try
             {
                 model.addItem(item);

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/Messages.java

@@ -20,6 +20,7 @@ public class Messages
                          OpenInEditor,
                          PrintImage,
                          PrintPlot,
+                         Refresh,
                          ReloadDisplay,
                          SaveImageSnapshot,
                          SavePlotSnapshot,

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/internal/DataBrowserWidgetRuntime.java

@@ -49,6 +49,20 @@ public void run()
         }
     }
 
+    private class RefreshPlotAction extends RuntimeAction
+    {
+        RefreshPlotAction()
+        {
+            super(Messages.Refresh, "/icons/refresh_remote.png");
+        }
+
+        @Override
+        public void run()
+        {
+            widget.runtimePropRefreshPlot().trigger();
+        }
+    }
+
     private final List<RuntimeAction> runtime_actions = new ArrayList<>(3);
     private volatile PV selection_pv = null;
     private volatile WidgetPropertyListener<VType> listener = null;
@@ -62,6 +76,7 @@ public void initialize(final DataBrowserWidget widget)
         runtime_actions.add(new OpenDataBrowserAction());
         runtime_actions.add(new PrintWidgetAction(widget, Messages.PrintPlot));
         runtime_actions.add(new SaveWidgetSnapshotAction(widget, Messages.SavePlotSnapshot));
+        runtime_actions.add(new RefreshPlotAction());
     }
 
     @Override

app/display/runtime/src/main/java/org/csstudio/display/builder/runtime/internal/StripchartWidgetRuntime.java

@@ -39,6 +39,20 @@ public void run()
         }
     }
 
+    private class RefreshPlotAction extends RuntimeAction
+    {
+        RefreshPlotAction()
+        {
+            super(Messages.Refresh, "/icons/refresh_remote.png");
+        }
+
+        @Override
+        public void run()
+        {
+            widget.runtimePropRefreshPlot().trigger();
+        }
+    }
+
     private final List<RuntimeAction> runtime_actions = new ArrayList<>(3);
 
     @Override
@@ -50,6 +64,7 @@ public void initialize(final StripchartWidget widget)
         runtime_actions.add(new OpenDataBrowserAction());
         runtime_actions.add(new PrintWidgetAction(widget, Messages.PrintPlot));
         runtime_actions.add(new SaveWidgetSnapshotAction(widget, Messages.SavePlotSnapshot));
+        runtime_actions.add(new RefreshPlotAction());
     }
 
     @Override

app/display/runtime/src/main/resources/icons/refresh_remote.png

@@ -4,6 +4,7 @@ OpenDataBrowser=Open Data Browser
 OpenInEditor=Open in Editor
 PrintImage=Print Image...
 PrintPlot=Print Plot...
+Refresh=Refresh Plot
 ReloadDisplay=Re-load Display
 SaveImageSnapshot=Save Image...
 SavePlotSnapshot=Save Plot...