Skip to content

Commit d355c64

Browse files
committed
Updated ordering and documentation
1 parent fc547ad commit d355c64

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

app/save-and-restore/app/doc/index.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -303,6 +303,29 @@ are shown by default. The left-most columns in the toolbar can be used to show/h
303303
.. image:: images/toggle-readback.png
304304
:width: 80%
305305

306+
While comparison of scalar values in the snapshot view is straight-forward, array (or table) type data is difficult
307+
to compare from the single table cells. User may instead click on the highlighted ":math:`{\Delta}` Live" cell to launch a dialog
308+
showing stored, live and :math:`{\Delta}` for the selected PV:
309+
310+
.. image:: images/snapshot-view-with-delta.png
311+
312+
User clicks "Click to compare":
313+
314+
.. image:: images/compare-arrays.png
315+
316+
The threshold settings works in the same manner is in the snapshot view and operates on each element (row) in the
317+
table view.
318+
319+
In case the stored and live value of the array/table data are of different dimensions, cells where no value is available
320+
will be rendered as "---". Moreover, since in these cases an absolute delta cannot be computed, the delta column will also show
321+
"---".
322+
323+
User may click the table header of the delta column to sort on the delta value to quickly find rows where either the
324+
stored or live value is not defined (due to difference in dimension). For such rows the absolute delta will be treated
325+
as infinite, which impacts ordering on the delta column:
326+
327+
.. image:: images/compare-arrays-infinite-delta.png
328+
306329
Restoring A Snapshot
307330
--------------------
308331

app/save-and-restore/app/src/test/java/org/phoebus/applications/saveandrestore/ui/snapshot/compare/ComparisonDialogDemo.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public void start(Stage primaryStage) {
3030
Alarm.none(),
3131
Time.now(), Display.none());
3232
ComparisonDialog comparisonDialog =
33-
new ComparisonDialog(vDoubleArray, "loc://x(3, 2, 1)");
33+
new ComparisonDialog(vDoubleArray, "loc://x(3, 2, 1, 1)");
3434
comparisonDialog.show();
3535
}
3636
}

0 commit comments

Comments
 (0)