The final restructured version for automatic build using maven tycho

[Mograsim.git] / plugins / net.mograsim.logic.model / src / net / mograsim / logic / model / snippets / HighLevelStateHandler.java

diff --git a/plugins/net.mograsim.logic.model/src/net/mograsim/logic/model/snippets/HighLevelStateHandler.java b/plugins/net.mograsim.logic.model/src/net/mograsim/logic/model/snippets/HighLevelStateHandler.java
new file mode 100644 (file)
index 0000000..622df00
--- /dev/null
+++ b/plugins/net.mograsim.logic.model/src/net/mograsim/logic/model/snippets/HighLevelStateHandler.java
@@ -0,0 +1,41 @@
+package net.mograsim.logic.model.snippets;
+
+import net.mograsim.logic.model.model.components.ModelComponent;
+import net.mograsim.logic.model.serializing.JSONSerializable;
+
+/**
+ * A high level state ID consists of parts separated by dots ('.').<br>
+ * The last part (the part after the last dot) is called "atomic high level state ID". The parts before that part are called "subcomponent
+ * ID"s.<br>
+ * If there is no dot in a high level state ID, the whole high level state ID is called atomic.<br>
+ * Note that subcomponent IDs don't have to correspond to actual subcomponents. For example, a RAM component may supply subcomponent IDs
+ * "c0000", "c0001" ... "cFFFF" without actually having a subcomponent for each cell. It also is allowed to delegate an atomic high level
+ * state ID to a subcomponent.
+ * 
+ * @author Daniel Kirschten
+ */
+public interface HighLevelStateHandler extends JSONSerializable
+{
+       /**
+        * Gets the current value of the given high-level state. <br>
+        * See {@link HighLevelStateHandler} for an explanation of high-level state IDs.
+        * 
+        * @see #setHighLevelState(String, Object)
+        * @see ModelComponent#getHighLevelState(String)
+        * 
+        * @author Daniel Kirschten
+        */
+       public Object getHighLevelState(String stateID);
+
+       /**
+        * Sets the given high-level state to the given value. <br>
+        * See {@link HighLevelStateHandler} for an explanation of high-level state IDs.
+        * 
+        * @see #getHighLevelState(String)
+        * @see ModelComponent#setHighLevelState(String, Object)
+        * 
+        * @author Daniel Kirschten
+        */
+       public void setHighLevelState(String stateID, Object newState);
+
+}
\ No newline at end of file