Restructured high level state access

[Mograsim.git] / net.mograsim.logic.ui / src / net / mograsim / logic / ui / model / components / GUIComponent.java

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
index f961caf..a80c15c 100644 (file)
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/components/GUIComponent.java
@@ -142,7 +142,13 @@ public abstract class GUIComponent
 
        /**
         * Sets the given high-level state to the given value. <br>
-        * TODO more documentation!
+        * 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 for an atomic high level state
+        * ID to be delegated to a subcomponent.
         * 
         * @author Daniel Kirschten
         */
@@ -154,7 +160,7 @@ public abstract class GUIComponent
 
        /**
         * Gets the current value of the given high-level state. <br>
-        * TODO more documentation!
+        * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
         * 
         * @author Daniel Kirschten
         */