implement connection table check in python (#1535)

Author: arun3688

src/OMSimulatorLib/System.cpp

@@ -1200,42 +1200,9 @@ oms_status_enu_t oms::System::addConnection(const oms::ComRef& crefA, const oms:
   {
     return logError("Unit mismatch in connection: " + std::string(crefA) + " -> " + std::string(crefB));
   }
-
-  // check if the connections are valid, according to the SSP-1.0 allowed connection table
-  if (oms::Connection::isValid(crefA, crefB, *conA, *conB))
-  {
-    connections.back() = new oms::Connection(crefA, crefB, suppressUnitConversion);
-    connections.push_back(NULL);
-  }
-  // flipped causality check
-  else if (oms::Connection::isValid(crefB, crefA, *conB, *conA))
-  {
-    // ! Flipped connection checks !
-    // Do not allow multiple connections to same 'input' connector
-    // (signal A!). The 'input' connector (signal A!) can actually be
-    // an output connector, e.g. if connecting a component to a system
-    // connector.
-    for (auto &connection : connections)
-    {
-      if (connection && connection->containsSignalB(crefA))
-        return logError("Connector " + std::string(crefA) + " is already connected to " + std::string(connection->getSignalA()));
-    }
-    connections.back() = new oms::Connection(crefB, crefA, suppressUnitConversion);
-    connections.push_back(NULL);
-  }
-  else if (oms::Connection::isValidExportConnectorName(*conA, *conB))
-  {
-    connections.back() = new oms::Connection(crefA, crefB, suppressUnitConversion);
-    connections.push_back(NULL);
-  }
-  // flipped causality check
-  else if (oms::Connection::isValidExportConnectorName(*conB, *conA))
-  {
-    connections.back() = new oms::Connection(crefB, crefA, suppressUnitConversion);
-    connections.push_back(NULL);
-  }
-  else
-    return logError("Causality mismatch in connection: " + std::string(crefA) + " -> " + std::string(crefB));
+  // connection are checked in the python side, directly add the connection
+  connections.back() = new oms::Connection(crefA, crefB, suppressUnitConversion);
+  connections.push_back(NULL);
 
   return oms_status_ok;
 }

src/OMSimulatorPython/connection.py

@@ -1,6 +1,7 @@
 from lxml import etree as ET
 
 from OMSimulator import namespace
+from OMSimulator.variable import Causality
 
 class ConnectionGeometry:
   def __init__(self, pointsX: list , pointsY: list):
@@ -63,3 +64,22 @@ def importFromNode(node, root):
         if pointsX and pointsY:
           connectionGeometry = ConnectionGeometry([float(x) for x in pointsX.split()], [float(y) for y in pointsY.split()])
           root.connections[-1].connectionGeometry = connectionGeometry
+
+  @staticmethod
+  def is_validConnection(source_owner: str, source_kind: Causality, dest_owner: str, dest_kind: Causality) -> bool:
+    """Return True if the connection is allowed according to SSP 2.0 table."""
+
+    # Allowed causality by owner type
+    allowed_source_by_owner = {
+      "System":  {Causality.input, Causality.parameter},
+      "Element": {Causality.output, Causality.calculatedParameter},
+    }
+
+    allowed_dest_by_owner = {
+      "System":  {Causality.output, Causality.calculatedParameter},
+      "Element": {Causality.input, Causality.parameter},
+    }
+
+    result = (source_kind in allowed_source_by_owner.get(source_owner, set()) and dest_kind in allowed_dest_by_owner.get(dest_owner, set()))
+
+    return result

src/OMSimulatorPython/system.py

@@ -434,15 +434,44 @@ def _addConnection(self, cref1: CRef, cref2: CRef) -> None:
       # Add the connections to top level system
       self.addConnection(start_element, start_connector, end_element, end_connector)
 
-  def addConnection(self, startElement : str, startConnector : str, endElement : str, endConnector : str):
-    #TODO: Fix this check for Connection class
-    #if (startElement, startConnector, endElement, endConnector) in self.connections:
-    #  raise ValueError(f"Connection '{startElement}.{startConnector}' to '{endElement}.{endConnector}' already exists")
+  def isConnectorAlreadyConnected(self, startElement : str, startConnector : str, endElement : str, endConnector : str):
+    """Check if a connection is valid in the system."""
+    for conn in self.connections:
+      if (conn.startElement == startElement and conn.startConnector == startConnector and
+          conn.endElement == endElement and conn.endConnector == endConnector):
+        raise ValueError(f"Connection from '{startElement}.{startConnector}' to '{endElement}.{endConnector}' already exists")
+
+  def _findConnector(self, element_name, connector_name):
+    """Returns (owner_string, causality) or (None, None) if not found."""
+    connectors = (
+        self.connectors  # System level
+        if not element_name else
+        self.elements[CRef(element_name)].connectors  # Element level
+    )
+    for con in connectors:
+      if str(con.name) == str(connector_name):
+        owner_str = "System" if not element_name else "Element"
+        return (owner_str, con.causality)
+
+    raise ValueError(f"Connector '{connector_name}' not found in element '{element_name or self.name}'")
 
-    #if (endElement, endConnector, startElement, startConnector) in self.connections:
-    #  raise ValueError(f"Connection '{startElement}.{startConnector}' to '{endElement}.{endConnector}' already exists")
+  def addConnection(self, startElement : str, startConnector : str, endElement : str, endConnector : str):
+    """Adds a connection to the system."""
+    # Resolve source connector owner and causality
+    (source_owner, source_kind) = self._findConnector(startElement, startConnector)
+    # Resolve destination connector owner and causality
+    (dest_owner, dest_kind) = self._findConnector(endElement, endConnector)
+
+    if Connection.is_validConnection(source_owner, source_kind, dest_owner, dest_kind):
+      self.isConnectorAlreadyConnected(startElement, startConnector, endElement, endConnector)
+      self.connections.append(Connection(startElement, startConnector, endElement, endConnector))
+    # flipped connection
+    elif Connection.is_validConnection(dest_owner, dest_kind, source_owner, source_kind):
+      self.isConnectorAlreadyConnected(endElement, endConnector, startElement, startConnector)
+      self.connections.append(Connection(endElement, endConnector, startElement, startConnector))
+    else:
+      raise ValueError(f"info: Invalid connection from '{startElement}.{startConnector}'->'{endElement}.{endConnector}' as causality are violated with '{source_owner}.{source_kind.name}' -> '{dest_owner}.{dest_kind.name}'")
 
-    self.connections.append(Connection(startElement, startConnector, endElement, endConnector))
 
   def _connectorExists(self, cref: CRef, delete = False) -> bool:
     """Check if a connector exists in the system."""

testsuite/AircraftVehicleDemonstrator/embrace1.py

@@ -32,7 +32,7 @@
 model.addConnection(CRef('root', 'ECS_HW', 'Mach'), CRef('root', 'BC', 'Mach'))
 
 #BC -> ECS_SW
-model.addConnection(CRef('root', 'BC', 'Aircraft_state'), CRef('root', 'AdaptionUnit.Aircraft_State'))
+model.addConnection(CRef('root', 'BC', 'Aircraft_state'), CRef('root', 'AdaptionUnit', 'Aircraft_State'))
 
 #BC -> Atmos
 model.addConnection(CRef('root', 'Atmos', 'Alt'), CRef('root', 'BC', 'Alt'))

testsuite/AircraftVehicleDemonstrator/embrace2.py

@@ -36,7 +36,7 @@
 model.addConnection(CRef('root', 'ECS_HW', 'Mach'), CRef('root', 'BC', 'Mach'))
 
 #BC -> ECS_SW
-model.addConnection(CRef('root', 'BC', 'Aircraft_state'), CRef('root', 'AdaptionUnit.Aircraft_State'))
+model.addConnection(CRef('root', 'BC', 'Aircraft_state'), CRef('root', 'AdaptionUnit', 'Aircraft_State'))
 
 #BC -> Atmos
 model.addConnection(CRef('root', 'Atmos', 'Alt'), CRef('root', 'BC', 'Alt'))

testsuite/api/deleteSystem1.py

@@ -89,7 +89,7 @@
 ## |-- |-- |-- |-- |-- |-- |-- Solver Settings:
 ## |-- |-- |-- |-- |-- |-- |-- |-- name: solver1
 ## |-- |-- |-- |-- |-- Connections:
-## |-- |-- |-- |-- |-- |-- Add2.u1 -> .input
+## |-- |-- |-- |-- |-- |-- .input -> Add2.u1
 ## |-- |-- |-- |-- FMU: Add1 'None'
 ## |-- |-- |-- |-- |-- path: resources/Add.fmu
 ## |-- |-- |-- |-- |-- Connectors:

testsuite/dcmotor/dcmotor.py

@@ -166,7 +166,7 @@
 ##  |-- |-- |-- SuT.I -> .I
 ##  |-- |-- |-- stimuli_model.M_load -> SuT.M_load
 ##  |-- |-- |-- stimuli_model.U -> SuT.U
-##  |-- |-- |-- .M_load -> stimuli_model.M_load
+##  |-- |-- |-- stimuli_model.M_load -> .M_load
 ##  |-- |-- |-- |-- ConnectionGeometry: (pointsX: [131.0, 131.0], pointsY: [-245.534819, -105.0])
 ##  |-- |-- SystemGeometry:
 ##  |-- |-- |-- (x1:-359.5, y1:-383.0, x2:710.0, y2:198.0)

testsuite/simulation/SimpleSimulation15.py

@@ -24,13 +24,18 @@
 subsystem.addConnector(Connector(CRef("u"), Causality.input, SignalType.Real))
 subsystem.addConnector(Connector(CRef("y"), Causality.output, SignalType.Real))
 
+## System.input -> Element.input
 subsystem.addConnection("", "u", "Add2", "u1")
+## System.input -> Element.input
 subsystem.addConnection("", "u", "Add2", "u2")
+## Element.output -> System.output
 subsystem.addConnection("", "y", "Add2", "y")
 
-
+## Element.output -> Element.input
 model.addConnection(CRef("default", "Add1", "y"), CRef("default", "sub-system", "u"))
-model.addConnection(CRef("default", "sub-system", "y"), CRef("default", "Add3", "u1"))
+## flip connection to test Element.output -> Element.input
+model.addConnection(CRef("default", "Add3", "u1"), CRef("default", "sub-system", "y"))
+## Element.output -> Element.input
 model.addConnection(CRef("default", "sub-system", "y"), CRef("default", "Add3", "u2"))
 
 ## check failing connection and fix it
@@ -97,7 +102,7 @@
 ## |-- |-- |-- |-- |-- Connections:
 ## |-- |-- |-- |-- |-- |-- .u -> Add2.u1
 ## |-- |-- |-- |-- |-- |-- .u -> Add2.u2
-## |-- |-- |-- |-- |-- |-- .y -> Add2.y
+## |-- |-- |-- |-- |-- |-- Add2.y -> .y
 ## |-- |-- |-- Connections:
 ## |-- |-- |-- |-- Add1.y -> sub-system.u
 ## |-- |-- |-- |-- sub-system.y -> Add3.u1

testsuite/simulation/exportJson2.py

@@ -155,7 +155,7 @@
 ##  |-- |-- |-- SuT.I -> .I
 ##  |-- |-- |-- stimuli_model.M_load -> SuT.M_load
 ##  |-- |-- |-- stimuli_model.U -> SuT.U
-##  |-- |-- |-- .M_load -> stimuli_model.M_load
+##  |-- |-- |-- stimuli_model.M_load -> .M_load
 ##  |-- |-- |-- |-- ConnectionGeometry: (pointsX: [131.0, 131.0], pointsY: [-245.534819, -105.0])
 ##  |-- |-- SystemGeometry:
 ##  |-- |-- |-- (x1:-359.5, y1:-383.0, x2:710.0, y2:198.0)

testsuite/simulation/exportJson4.py

@@ -30,7 +30,8 @@
 model.setSolver(CRef('default', 'sub-system', 'Add2'), 'solver1')
 
 model.addConnection(CRef('default', 'param1'), CRef('default', 'Add1', 'u1'))
-model.addConnection(CRef('default', 'Add1', 'y'), CRef('default', 'sub-system', 'output'))
+## Element.output -> System.output
+model.addConnection(CRef('default', 'sub-system', 'Add2', 'y'), CRef('default', 'sub-system', 'output'))
 model.addConnection(CRef('default', 'sub-system', 'Add2', 'u1'), CRef('default', 'sub-system', 'input'))
 
 model.export('exportJson4.ssp')
@@ -42,6 +43,7 @@
 # print(instantiated_model.dumpApiCalls(), flush=True)
 instantiated_model.setResultFile("export_json4_res.mat")
 instantiated_model.setValue(CRef('default', 'param1'), 2.0)
+instantiated_model.setValue(CRef('default', 'sub-system', 'input'), 5.0)
 instantiated_model.setValue(CRef('default', 'Add1', 'u2'), 3.0)
 
 print(f"info: After instantiation:")
@@ -94,7 +96,8 @@
 ## |-- |-- |-- |-- |-- |-- |-- Solver Settings:
 ## |-- |-- |-- |-- |-- |-- |-- |-- name: solver1
 ## |-- |-- |-- |-- |-- Connections:
-## |-- |-- |-- |-- |-- |-- Add2.u1 -> .input
+## |-- |-- |-- |-- |-- |-- Add2.y -> .output
+## |-- |-- |-- |-- |-- |-- .input -> Add2.u1
 ## |-- |-- |-- |-- FMU: Add1 'None'
 ## |-- |-- |-- |-- |-- path: resources/Add.fmu
 ## |-- |-- |-- |-- |-- Connectors:
@@ -107,23 +110,22 @@
 ## |-- |-- |-- |-- |-- |-- name: solver1
 ## |-- |-- |-- Connections:
 ## |-- |-- |-- |-- .param1 -> Add1.u1
-## |-- |-- |-- |-- Add1.y -> sub-system.output
 ## |-- |-- |-- Solver Settings:
 ## |-- |-- |-- |-- (name=solver1, method=euler, tolerance=1e-06)
 ## |-- DefaultExperiment
 ## |-- |-- startTime: 0.0
 ## |-- |-- stopTime: 1.0
 ## info: After instantiation:
 ## info:    default.param1           : 2.0
-## info:    default.sub-system.input : 0.0
+## info:    default.sub-system.input : 5.0
 ## info:    default.sub-system.output: 0.0
 ## info:    default.Add1.u1          : 0.0
 ## info:    default.Add1.u2          : 3.0
 ## info:    default.Add1.y           : 3.0
 ## info:    Result file: export_json4_res.mat (bufferSize=1)
 ## info: After simulation:
 ## info:    default.param1           : 2.0
-## info:    default.sub-system.input : 0.0
+## info:    default.sub-system.input : 5.0
 ## info:    default.sub-system.output: 5.0
 ## info:    default.Add1.u1          : 2.0
 ## info:    default.Add1.u2          : 3.0