X-Git-Url: https://mograsim.net/gitweb/?a=blobdiff_plain;f=net.mograsim.logic.ui%2Fsrc%2Fnet%2Fmograsim%2Flogic%2Fui%2Fmodel%2Fwires%2FWireCrossPoint.java;h=de5ba4ac5026bb1eeedfec536434acbd5ddf64da;hb=67c7e16eac6ef555f7ebe0cbe6048598d7f1187e;hp=f79cf9aa43050c3286175c3afec1be5ad9387ba6;hpb=74868b10728aee0e85e4ff8af4073516b7590268;p=Mograsim.git

diff --git a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/WireCrossPoint.java b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/WireCrossPoint.java
index f79cf9aa..de5ba4ac 100644
--- a/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/WireCrossPoint.java
+++ b/net.mograsim.logic.ui/src/net/mograsim/logic/ui/model/wires/WireCrossPoint.java
@@ -4,7 +4,6 @@ import java.util.Map;
 
 import net.haspamelodica.swt.helper.gcs.GeneralGC;
 import net.haspamelodica.swt.helper.swtobjectwrappers.Rectangle;
-import net.mograsim.logic.core.LogicObservable;
 import net.mograsim.logic.core.LogicObserver;
 import net.mograsim.logic.core.types.BitVectorFormatter;
 import net.mograsim.logic.core.wires.Wire.ReadEnd;
@@ -13,27 +12,59 @@ import net.mograsim.logic.ui.model.ViewModelModifiable;
 import net.mograsim.logic.ui.model.components.GUIComponent;
 import net.mograsim.logic.ui.model.components.SimpleRectangularGUIGate;
 
+/**
+ * A {@link GUIComponent} with only one pin. Is used to create wires connecting more than two pins. <br>
+ * Example: There are three pins <code>P1</code>, <code>P2</code>, <code>P3</code> that need to be connected. Solution: Create a
+ * WireCrossPoint (<code>WCP</code>) and create the GUIWires <code>P1</code>-<code>WCP</code>, <code>P2</code>-<code>WCP</code>,
+ * <code>P3</code>-<code>WCP</code>.<br>
+ * Cross points are drawn as circles. The pin of cross points is in the center of this circle.
+ * 
+ * @author Daniel Kirschten
+ */
 public class WireCrossPoint extends GUIComponent
 {
 	private static final int CIRCLE_RADIUS = 1;
 	private static final int CIRCLE_DIAM = CIRCLE_RADIUS * 2;
 
+	/**
+	 * The (single) pin of this cross point.
+	 */
 	private final Pin pin;
-	private final int logicWidth;
 
+	/**
+	 * A {@link LogicObserver} calling {@link #requestRedraw()}.
+	 */
 	private final LogicObserver logicObs;
+	/**
+	 * The {@link ReadEnd} currently bound to this cross point.
+	 */
 	private ReadEnd end;
 
+	// creation and destruction
+
 	public WireCrossPoint(ViewModelModifiable model, int logicWidth)
 	{
 		super(model);
 		logicObs = (i) -> requestRedraw();
 
-		this.logicWidth = logicWidth;
 		setSize(CIRCLE_DIAM, CIRCLE_DIAM);
 		addPin(this.pin = new Pin(this, "", logicWidth, CIRCLE_RADIUS, CIRCLE_RADIUS));
 	}
 
+	// pins
+
+	public Pin getPin()
+	{
+		return pin;
+	}
+
+	// "graphical" operations
+
+	/**
+	 * Moves the center (and therefore the pin) of this {@link WireCrossPoint} to the given location.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public void moveCenterTo(double x, double y)
 	{
 		moveTo(x - CIRCLE_RADIUS, y - CIRCLE_RADIUS);
@@ -46,40 +77,39 @@ public class WireCrossPoint extends GUIComponent
 				() -> gc.fillOval(getPosX(), getPosY(), CIRCLE_DIAM, CIRCLE_DIAM));
 	}
 
+	// logic model binding
+
+	/**
+	 * Binds this {@link WireCrossPoint} to the given {@link ReadEnd}: The color of this {@link WireCrossPoint} will now depend on the state
+	 * of the given {@link ReadEnd}, and further changes of the given {@link ReadEnd} will result in readrawListeners being called.<br>
+	 * The argument can be null, in which case the old binding is stopped.
+	 * 
+	 * @author Daniel Kirschten
+	 */
 	public void setLogicModelBinding(ReadEnd end)
 	{
-		deregisterLogicObs(this.end);
+		if (this.end != null)
+			this.end.deregisterObserver(logicObs);
 		this.end = end;
-		registerLogicObs(end);
+		if (end != null)
+			end.registerObserver(logicObs);
 	}
 
-	private void registerLogicObs(LogicObservable observable)
+	/**
+	 * Returns whether this {@link WireCrossPoint} has a logic model binding or not.
+	 */
+	public boolean hasLogicModelBinding()
 	{
-		if (observable != null)
-			observable.registerObserver(logicObs);
+		return end != null;
 	}
 
-	private void deregisterLogicObs(LogicObservable observable)
-	{
-		if (observable != null)
-			observable.deregisterObserver(logicObs);
-	}
-
-	public int getLogicWidth()
-	{
-		return logicWidth;
-	}
-
-	public Pin getPin()
-	{
-		return pin;
-	}
+	// serializing
 
 	@Override
 	public Map<String, Object> getInstantiationParameters()
 	{
 		Map<String, Object> m = super.getInstantiationParameters();
-		m.put(SimpleRectangularGUIGate.kLogicWidth, logicWidth);
+		m.put(SimpleRectangularGUIGate.kLogicWidth, pin.logicWidth);
 		return m;
 	}
 }
\ No newline at end of file