Changeset 11248 for trunk/sources

Timestamp:

07/31/14 00:08:24 (10 years ago)

Author:

bburlacu

Message:

#2223: Added item attributes and firing of events in the DirectedGraph.

Location:

trunk/sources/HeuristicLab.Core/3.3/Collections/DirectedGraph

Files:

• Arc.cs (modified) (1 diff)
• DirectedGraph.cs (modified) (7 diffs)
• Vertex.cs (modified) (1 diff)

trunk/sources/HeuristicLab.Core/3.3/Collections/DirectedGraph/Arc.cs

@@ -25 +25 @@
 
 namespace HeuristicLab.Core {
-  /// <summary>
-  /// An arc that can have a weight, a label, and a data object for holding additional info
-  /// </summary>
+  [Item("Arc", "A graph arc connecting two graph vertices, that can have a weight, label, and data object for holding additional info")]
   [StorableClass]
   public class Arc : Item, IArc {

trunk/sources/HeuristicLab.Core/3.3/Collections/DirectedGraph/DirectedGraph.cs

@@ -71 +71 @@
     private void AfterDeserialization() {
       foreach (var vertex in vertices) {
-        vertex.ArcAdded += OnArcAdded;
-        vertex.ArcRemoved += OnArcRemoved;
+        vertex.ArcAdded += OnVertexArcAdded;
+        vertex.ArcRemoved += OnVertexArcRemoved;
       }
 
@@ -91 +91 @@
       vertices.Add(vertex);
       // register event handlers
-      vertex.ArcAdded += OnArcAdded;
-      vertex.ArcRemoved += OnArcRemoved;
+      vertex.ArcAdded += OnVertexArcAdded;
+      vertex.ArcRemoved += OnVertexArcRemoved;
+      OnVertedAdded(this, EventArgs.Empty);
     }
 
@@ -102 +103 @@
         RemoveArc(arc);
       // deregister event handlers
-      vertex.ArcAdded -= OnArcAdded;
-      vertex.ArcRemoved -= OnArcRemoved;
+      vertex.ArcAdded -= OnVertexArcAdded;
+      vertex.ArcRemoved -= OnVertexArcRemoved;
+      OnVertexRemoved(this, EventArgs.Empty); // do not pass the removed vertex in the event as we don't need it anymore
     }
 
@@ -118 +120 @@
       target.AddArc(arc);
       arcs.Add(arc);
+      OnArcAdded(this, EventArgs.Empty);
     }
 
@@ -126 +129 @@
       source.RemoveArc(arc);
       target.RemoveArc(arc);
+      OnArcRemoved(this, EventArgs.Empty);
     }
 
-    public event EventHandler ArcAdded;
-    protected virtual void OnArcAdded(object sender, EventArgs<IArc> args) {
+    protected virtual void OnVertexArcAdded(object sender, EventArgs<IArc> args) {
       var arc = args.Value;
-      // the ArcAdded event is fired by a vertex when an arc from or towards another vertex is added to his list of connections
+      // the ArcAdded event is fired by a vertex when an arc from/to another vertex is added to its list of connections
       // because the arc is added in both directions by both the source and the target, this event will get fired twice 
       // here, we only want to add the arc once, so if its already contained, we return without complaining
@@ -138 +141 @@
     }
 
-
-    public event EventHandler ArcRemoved;
-    protected virtual void OnArcRemoved(object sender, EventArgs<IArc> args) {
+    protected virtual void OnVertexArcRemoved(object sender, EventArgs<IArc> args) {
       var arc = args.Value;
       if (!arcs.Contains(arc)) return; // the same rationale as above 
@@ -148 +149 @@
     // events
     public event EventHandler VertexAdded;
+    protected virtual void OnVertedAdded(object sender, EventArgs args) {
+      var added = VertexAdded;
+      if (added != null)
+        added(sender, args);
+    }
+
     public event EventHandler VertexRemoved;
+    protected virtual void OnVertexRemoved(object sender, EventArgs args) {
+      var removed = VertexRemoved;
+      if (removed != null)
+        removed(sender, args);
+    }
+
+    public event EventHandler ArcAdded;
+    protected virtual void OnArcAdded(object sender, EventArgs args) {
+      var added = ArcAdded;
+      if (added != null)
+        added(sender, args);
+    }
+
+    public event EventHandler ArcRemoved;
+    protected virtual void OnArcRemoved(object sender, EventArgs args) {
+      var removed = ArcRemoved;
+      if (removed != null)
+        removed(sender, args);
+    }
   }
 }

trunk/sources/HeuristicLab.Core/3.3/Collections/DirectedGraph/Vertex.cs

@@ -27 +27 @@
 
 namespace HeuristicLab.Core {
+  [Item("Vertex", "An object representing a vertex in the graph. It can have a text label, a weight, and an additional data object.")]
   [StorableClass]
   public class Vertex : Item, IVertex {