X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fcomponents%2FGUIComponent.java;h=a80c15c42ed216c89152399c30ea0e4cbffd9368;hb=66f8cbab0c292761a8a34f5c5e2d5e4434672d44;hp=fd48e6218902772a3d7e157471e7727ecb7e76fd;hpb=74bced7a3a38f65c65f3395cc422eb98e34da0b8;p=Mograsim.git

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 fd48e621..a80c15c4 100644
--- 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
@@ -140,12 +140,30 @@ public abstract class GUIComponent
 
 	// high-level access
 
+	/**
+	 * Sets the given high-level state to the given value. <br>
+	 * 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
+	 */
 	@SuppressWarnings({ "static-method", "unused" }) // this method is intended to be overridden
 	public void setHighLevelState(String stateID, Object newState)
 	{
 		throw new IllegalArgumentException("No high level state with ID " + stateID);
 	}
 
+	/**
+	 * Gets the current value of the given high-level state. <br>
+	 * See {@link #setHighLevelState(String, Object)} for an explanation of high-level state IDs.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	@SuppressWarnings("static-method") // this method is intended to be overridden
 	public Object getHighLevelState(String stateID)
 	{