Changeset 11530 for branches/OptimizationNetworks/HeuristicLab.Optimization.Networks/3.3/Core.Networks/MessagePort.cs

Timestamp:

11/10/14 04:24:04 (9 years ago)

Author:

swagner

Message:

#2205: Implemented review comments

• renamed GenericPort to MessagePort
• refactored CanConnectToPort
• refactored PrepareMessage
• removed IConnectedPort

Additional changes:

• added UserDefinedMessagePort
• refactored CloneConnectedPortParameters to CloneParametersFromPort and moved it to ParameterizedPort
• added ports to NetworkView

File:

• branches/OptimizationNetworks/HeuristicLab.Optimization.Networks/3.3/Core.Networks/MessagePort.cs (moved) (moved from branches/OptimizationNetworks/HeuristicLab.Optimization.Networks/3.3/Core.Networks/GenericPort.cs) (10 diffs)

branches/OptimizationNetworks/HeuristicLab.Optimization.Networks/3.3/Core.Networks/MessagePort.cs

@@ -23 +23 @@
 using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
 using System;
+using System.Collections.Generic;
 using System.Drawing;
 using System.Linq;
@@ -29 +30 @@
 
 namespace HeuristicLab.Core.Networks {
-  [Item("GenericPort", "A generic port of an optimization network node.")]
+  [Item("MessagePort", "A port of a network node for sending and receiving messages.")]
   [StorableClass]
-  public class GenericPort : ParameterizedPort, IGenericPort, IConnectedPort {
+  public class MessagePort : ParameterizedPort, IMessagePort {
     public override Image ItemImage {
       get {
@@ -44 +45 @@
 
     [Storable]
-    protected IConnectedPort connectedPort;
-    public IConnectedPort ConnectedPort {
+    protected IMessagePort connectedPort;
+    public IMessagePort ConnectedPort {
       get { return connectedPort; }
       set {
@@ -87 +88 @@
 
     [StorableConstructor]
-    protected GenericPort(bool deserializing) : base(deserializing) { }
-    protected GenericPort(GenericPort original, Cloner cloner)
+    protected MessagePort(bool deserializing) : base(deserializing) { }
+    protected MessagePort(MessagePort original, Cloner cloner)
       : base(original, cloner) {
       connectedPort = cloner.Clone(original.connectedPort);
@@ -96 +97 @@
       RegisterConnectedPortEvents();
     }
-    public GenericPort()
-      : base("GenericPort") {
+    public MessagePort()
+      : base("MessagePort") {
       portConnectionValid = true;
       logMessages = false;
       messages = new MessageCollection();
     }
-    public GenericPort(string name)
+    public MessagePort(string name)
       : base(name) {
       portConnectionValid = true;
@@ -108 +109 @@
       messages = new MessageCollection();
     }
-    public GenericPort(string name, string description)
+    public MessagePort(string name, string description)
       : base(name, description) {
       portConnectionValid = true;
@@ -121 +122 @@
 
     public override IDeepCloneable Clone(Cloner cloner) {
-      return new GenericPort(this, cloner);
+      return new MessagePort(this, cloner);
     }
 
@@ -127 +128 @@
       if (port == null) return true;
 
-      var cp = port as IConnectedPort;
-      if (cp == null) return false;
-
-      // check connected port input parameters
-      foreach (var input in cp.Parameters.Where(p => p.Type.HasFlag(PortParameterType.Input))) {
-        IPortParameter param;
-        Parameters.TryGetValue(input.Name, out param);
-        if ((param == null) && (input.DefaultValue == null)) return false;
-        if (!param.Type.HasFlag(PortParameterType.Output)) return false;
-        if (!input.DataType.IsAssignableFrom(param.DataType)) return false;
-      }
-      // check local port input parameters
-      foreach (var input in Parameters.Where(p => p.Type.HasFlag(PortParameterType.Input))) {
-        IPortParameter param;
-        cp.Parameters.TryGetValue(input.Name, out param);
-        if ((param == null) && (input.DefaultValue == null)) return false;
-        if (!param.Type.HasFlag(PortParameterType.Output)) return false;
-        if (!input.DataType.IsAssignableFrom(param.DataType)) return false;
-      }
+      var p = port as IMessagePort;
+      if (p == null) return false;
+
+      // check if the local parameters are compatible to the input parameters of the port
+      if (!ParametersCompatibleToTarget(Parameters, p.Parameters)) return false;
+      // check if the parameters of the port are compatible to the local input parameters
+      if (!ParametersCompatibleToTarget(p.Parameters, Parameters)) return false;
+
       return true;
-    }
-    public void CloneConnectedPortParameters() {
-      Parameters.Clear();
-      foreach (var p in connectedPort.Parameters) {
-        var param = (IPortParameter)p.Clone();
-        if (!(param.Type.HasFlag(PortParameterType.Input) && param.Type.HasFlag(PortParameterType.Output))) {
-          param.Type = ~param.Type;  // bitwise negation: input -> output, output -> input
-        }
-        Parameters.Add(param);
-      }
     }
 
@@ -163 +143 @@
       var message = new Message();
 
-      // collect output parameters from local port
-      message.Values.AddRange(
-        Parameters
-          .Where(p => p.Type.HasFlag(PortParameterType.Output))
-          .Select(p => p.CreateMessageValue())
-      );
-
-      // collect remaining input parameters from connected port
+      // collect parameters from local port
+      message.Values.AddRange(Parameters.Select(p => p.CreateMessageValue()));
+
+      // collect remaining parameters from connected port
       if (ConnectedPort != null) {
         message.Values.AddRange(
           ConnectedPort.Parameters
-            .Where(p => p.Type.HasFlag(PortParameterType.Input) && !message.Values.ContainsKey(p.Name))
+            .Where(p => !message.Values.ContainsKey(p.Name))
             .Select(p => p.CreateMessageValue())
         );
       }
-
-      // collect output parameters from connected port
-      if (ConnectedPort != null) {
-        message.Values.AddRange(
-          ConnectedPort.Parameters
-            .Where(p => p.Type.HasFlag(PortParameterType.Output) && !message.Values.ContainsKey(p.Name))
-            .Select(p => p.CreateMessageValue())
-        );
-      }
-
-      // collect remaining input parameters from local port
-      message.Values.AddRange(
-        Parameters
-          .Where(p => p.Type.HasFlag(PortParameterType.Input) && !message.Values.ContainsKey(p.Name))
-          .Select(p => p.CreateMessageValue())
-      );
 
       return message;
@@ -270 +230 @@
     }
     #endregion
+
+    #region Helpers
+    protected virtual bool ParametersCompatibleToTarget(IEnumerable<IPortParameter> source, IEnumerable<IPortParameter> target) {
+      // checks if the source parameters are compatible to the input parameters of the target
+      foreach (var input in target.Where(p => p.Type.HasFlag(PortParameterType.Input))) {
+        var param = source.Where(p => input.Name == p.Name).FirstOrDefault();
+        if (param == null) {
+          if (input.DefaultValue == null) return false;
+        } else {
+          if (!param.Type.HasFlag(PortParameterType.Output)) return false;
+          if (!input.DataType.IsAssignableFrom(param.DataType)) return false;
+        }
+      }
+      return true;
+    }
+    #endregion
   }
 }