#41 adding VStatistics

Author: shroffk

epics-vtype/vtype/src/main/java/org/epics/vtype/IVStatistics.java

@@ -0,0 +1,76 @@
+/**
+ * Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
+ * All rights reserved. Use is subject to license terms. See LICENSE.TXT
+ */
+package org.epics.vtype;
+
+/**
+ * VStatistics implementation.
+ *
+ * @author carcassi
+ */
+class IVStatistics extends VStatistics {
+
+    private Double average;
+    private Double stdDev;
+    private Double min;
+    private Double max;
+    private Integer nSamples;
+
+    private final Alarm alarm;
+    private final Time time;
+    private final Display display;
+
+    IVStatistics(Double average, Double stdDev, Double min, Double max, Integer nSamples, Alarm alarm, Time time, Display display) {
+        this.average = average;
+        this.stdDev = stdDev;
+        this.min = min;
+        this.max = max;
+        this.nSamples = nSamples;
+
+        this.alarm = alarm;
+        this.time = time;
+        this.display = display;
+    }
+
+    @Override
+    public Double getAverage() {
+        return average;
+    }
+
+    @Override
+    public Double getStdDev() {
+        return stdDev;
+    }
+
+    @Override
+    public Double getMin() {
+        return min;
+    }
+
+    @Override
+    public Double getMax() {
+        return max;
+    }
+
+    @Override
+    public Integer getNSamples() {
+        return nSamples;
+    }
+
+    @Override
+    public Alarm getAlarm() {
+        return alarm;
+    }
+
+    @Override
+    public Time getTime() {
+        return time;
+    }
+
+    @Override
+    public Display getDisplay() {
+        return display;
+    }
+
+}

epics-vtype/vtype/src/main/java/org/epics/vtype/Statistics.java

@@ -0,0 +1,57 @@
+/**
+ * Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
+ * All rights reserved. Use is subject to license terms. See LICENSE.TXT
+ */
+package org.epics.vtype;
+
+/**
+ * Basic type for statistical information of numeric types. The methods never
+ * return null, even if no connection was ever made. One <b>must always look</b>
+ * at the alarm severity to be able to correctly interpret the value.
+ * <p>
+ * This type can be used regardless of the method used to calculate the average
+ * (instances: &Sigma;<i>x<sub>i</sub>/N</i>, time:
+ * &Sigma;<i>x<sub>i</sub>&Delta;t<sub>i</sub>/&Delta;t</i>, time with linear
+ * interpolation, exponential backoff, ...).
+ * <p>
+ * No integer statistics, since averages are not integer in general.
+ *
+ * @author carcassi
+ */
+public abstract class Statistics extends VType implements AlarmProvider, TimeProvider, DisplayProvider {
+
+    /**
+     * The average. Never null.
+     *
+     * @return the average
+     */
+    public abstract Double getAverage();
+
+    /**
+     * The standard deviation. Never null.
+     *
+     * @return the standard deviation
+     */
+    public abstract Double getStdDev();
+
+    /**
+     * The minimum value.
+     *
+     * @return the minimum
+     */
+    public abstract Double getMin();
+
+    /**
+     * The maximum value.
+     *
+     * @return the maximum
+     */
+    public abstract Double getMax();
+
+    /**
+     * The number of samples.
+     *
+     * @return the number of samples
+     */
+    public abstract Integer getNSamples();
+}

epics-vtype/vtype/src/main/java/org/epics/vtype/VStatistics.java

@@ -0,0 +1,90 @@
+/**
+ * Copyright (C) 2010-18 diirt developers. See COPYRIGHT.TXT
+ * All rights reserved. Use is subject to license terms. See LICENSE.TXT
+ */
+package org.epics.vtype;
+
+import java.util.Objects;
+
+/**
+ * Statistics for double with alarm, timestamp and display information.
+ *
+ * @author carcassi
+ */
+public abstract class VStatistics extends Statistics {
+
+    /**
+     * Creates a new VStatistics.
+     *
+     * @param average average
+     * @param stdDev standard deviation
+     * @param min minimum
+     * @param max maximum
+     * @param nSamples number of samples
+     * @param alarm the alarm
+     * @param time the time
+     * @param display the display
+     * @return the new value
+     */
+    public static VStatistics of(final double average, final double stdDev,
+            final double min, final double max, final int nSamples, final Alarm alarm,
+            final Time time, final Display display) {
+        return new IVStatistics(average, stdDev, min, max, nSamples, alarm, time, display);
+    }
+
+    @Override
+    public final String toString() {
+        StringBuilder builder = new StringBuilder();
+        Class type = typeOf(this);
+        builder.append(type.getSimpleName())
+                .append('[')
+                .append("max:" + getMax())
+                .append(", min:" + getMin())
+                .append(", mean:" + getAverage())
+                .append(", std:" + getStdDev())
+                .append(", #samples" + getNSamples())
+                .append(", ")
+                .append(getAlarm())
+                .append(", ")
+                .append(getTime())
+                .append(']');
+        return builder.toString();
+    }
+
+    @Override
+    public final boolean equals(Object obj) {
+        if (this == obj) {
+            return true;
+        }
+
+        if (obj instanceof VStatistics) {
+            VStatistics other = (VStatistics) obj;
+
+            return getClass().equals(other.getClass()) &&
+                    getMax().equals(other.getMax()) &&
+                    getMin().equals(other.getMin()) &&
+                    getAverage().equals(other.getAverage()) &&
+                    getStdDev().equals(other.getStdDev()) &&
+                    getNSamples().equals(other.getNSamples()) &&
+                    getAlarm().equals(other.getAlarm()) &&
+                    getTime().equals(other.getTime()) &&
+                    getDisplay().equals(other.getDisplay());
+        }
+
+        return false;
+    }
+
+    @Override
+    public final int hashCode() {
+        int hash = 7;
+        hash = 23 * hash + Objects.hashCode(getMax());
+        hash = 23 * hash + Objects.hashCode(getMin());
+        hash = 23 * hash + Objects.hashCode(getAverage());
+        hash = 23 * hash + Objects.hashCode(getStdDev());
+        hash = 23 * hash + Objects.hashCode(getNSamples());
+        hash = 23 * hash + Objects.hashCode(getAlarm());
+        hash = 23 * hash + Objects.hashCode(getTime());
+        hash = 23 * hash + Objects.hashCode(getDisplay());
+        return hash;
+    }
+}