Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.history / src / org / simantics / history / HistoryItem.java

diff --git a/bundles/org.simantics.history/src/org/simantics/history/HistoryItem.java b/bundles/org.simantics.history/src/org/simantics/history/HistoryItem.java
new file mode 100644 (file)
index 0000000..0c48308
--- /dev/null
+++ b/bundles/org.simantics.history/src/org/simantics/history/HistoryItem.java
@@ -0,0 +1,47 @@
+package org.simantics.history;\r
+\r
+import org.simantics.databoard.annotations.Identifier;\r
+import org.simantics.databoard.type.Datatype;\r
+import org.simantics.databoard.util.Bean;\r
+\r
+/**\r
+ * (Utility Class) Item format for HistoryItem.\r
+ *\r
+ * @author toni.kalajainen@semantum.fi\r
+ */\r
+public class HistoryItem extends Bean.Id  {\r
+\r
+       /** \r
+        * Unique identifier of the item.\r
+        */\r
+       public @Identifier String id;\r
+       \r
+       /** \r
+        * Describes the format of the packed sample. The sample must be a record.\r
+        * The record must have any combination of the following named fields.\r
+        * The field types must one of: byte, integer, long, float, double.\r
+        * \r
+        * time, endTime, value - are mandatory fields.\r
+        * \r
+        *  time      -  Region start time, the time of the 1st sample included into the band\r
+        *  endTime   -  Region end time, the time of the last sample included into the band\r
+        *  \r
+        *  value     -  First value in the band\r
+        *  lastValue -  Last value in the band\r
+        *  avg       -  Average value of all included samples\r
+        *  median    -  Median value of all samples in the band\r
+        *  min       -  Lowest value in the band\r
+        *  max       -  Highest value in the band\r
+        *  \r
+        *  quality   -  0 = Good, -1 = No value\r
+        *  count     -  The number of included samples in the band\r
+        */\r
+       public Datatype format;\r
+       \r
+       public HistoryItem(String id, Datatype format) {\r
+               super();\r
+               this.id = id;\r
+               this.format = format;\r
+       }\r
+       \r
+}\r