Update of save&restore config pv data model to include comparison data

Author: georgweiss

app/save-and-restore/model/src/main/java/org/phoebus/applications/saveandrestore/model/Comparison.java

@@ -0,0 +1,9 @@
+/*
+ * Copyright (C) 2024 European Spallation Source ERIC.
+ */
+
+package org.phoebus.applications.saveandrestore.model;
+
+public record Comparison(PvCompareMode pvCompareMode, double tolerance) {
+
+}

app/save-and-restore/model/src/main/java/org/phoebus/applications/saveandrestore/model/ConfigPv.java

@@ -24,15 +24,36 @@
  * Class encapsulating data to describe a PV subject to a save operation. A read-back PV name
  * is optionally associated with the PV name. A PV record is uniquely identified by both the PV name
  * and the read-back PV name (if it has been specified).
+ * <p>
+ *     If a read-back PV name has been specified, a {@link Comparison} can be specified to
+ *     indicate if and how the stored read-back value is compared to the live read-back value
+ *     if a client requests it.
+ * </p>
  * @author georgweiss
  * Created 1 Oct 2018
  */
 public class ConfigPv implements Comparable<ConfigPv>{
 
+	/**
+	 * Set-point PV name.
+	 */
 	private String pvName;
+
+	/**
+	 * Optional read-back PV name
+	 */
 	private String readbackPvName;
+
+	/**
+	 * Flag indicating if set-point PV value should be restored or not.
+	 */
 	private boolean readOnly = false;
 
+	/**
+	 * Optional comparison data for the read-back PV.
+	 */
+	private Comparison comparison;
+
 	public String getPvName() {
 		return pvName;
 	}
@@ -57,6 +78,14 @@ public void setReadOnly(boolean readOnly) {
 		this.readOnly = readOnly;
 	}
 
+	public Comparison getComparison() {
+		return comparison;
+	}
+
+	public void setComparison(Comparison comparison) {
+		this.comparison = comparison;
+	}
+
 	@Override
 	public boolean equals(Object other) {
 		if(other instanceof ConfigPv) {
@@ -118,6 +147,11 @@ public Builder readOnly(boolean readOnly){
 			return this;
 		}
 
+		public Builder comparison(Comparison comparison){
+			configPv.setComparison(comparison);
+			return this;
+		}
+
 		public ConfigPv build(){
 			return configPv;
 		}

app/save-and-restore/model/src/main/java/org/phoebus/applications/saveandrestore/model/PvCompareMode.java

@@ -0,0 +1,11 @@
+/*
+ * Copyright (C) 2024 European Spallation Source ERIC.
+ */
+
+package org.phoebus.applications.saveandrestore.model;
+
+public enum PvCompareMode {
+    NONE,
+    RELATIVE,
+    ABSOLUTE;
+}

app/save-and-restore/model/src/test/java/org/phoebus/applications/saveandrestore/model/ConfigPvTest.java

@@ -42,6 +42,11 @@ public void testConfigPv() {
 
 		assertEquals("b", configPV.getReadbackPvName());
 		assertTrue(configPV.isReadOnly());
+		assertNull(configPV.getComparison());
+
+		configPV = ConfigPv.builder().pvName("a").readbackPvName("b").readOnly(true).comparison(new Comparison(PvCompareMode.ABSOLUTE, 1.0)).build();
+		assertEquals(PvCompareMode.ABSOLUTE, configPV.getComparison().pvCompareMode());
+		assertEquals(1.0, configPV.getComparison().tolerance());
 	}
 
 	@Test