add FMI-3.0 SSP support (#1571)

* fix variable types
* pass fmi3 types to values
* fix signal types when importing from ssp
* allow type=None to support parameter mapping
* check connector signaltype

Author: arun3688

src/OMSimulatorPython/component.py

@@ -145,7 +145,12 @@ def exportToSSD(self, node):
       utils.exportAnnotations(component_node, self.solver)
 
   def setValue(self, cref:str, value, unit=None, description = None):
-    self.value.setValue(cref, value, unit, description)
+    for connector in self.connectors:
+      if str(connector.name) == str(cref):
+        self.value.setValue(cref, value, connector.signal_type, unit, description)
+        return
+    ## it is possible that the parameter is not defined as connector but only in the ssv file or ssm mapping, so we allow setting values without types
+    self.value.setValue(cref, value, None, unit, description)
 
   def getValue(self, cref:str):
     return self.value.getValue(cref)

src/OMSimulatorPython/instantiated_model.py

@@ -276,31 +276,32 @@ def setStartValues(self, value: Values, systemName: str, ssm: SSM | None):
     if ssm and ssm.mappingEntry:
       for source, targets in ssm.mappingEntry.items():
         if CRef(source) in value.start_values:
-          source_value, _, _ = value.start_values[CRef(source)]
+          (source_value, type, _, _) = value.start_values[CRef(source)]
           for entry in targets:
             target = entry["target"]
             linearTransformation = entry["linearTransformation"]
             value_path = self.map_cref(systemName, str(target))
             if linearTransformation:
               source_value = source_value * float(linearTransformation.factor) + float(linearTransformation.offset)
-            self.apply_start_value(value_path, source_value)
+            self.apply_start_value(value_path, source_value, type)
     else:
-      for key, (source_value, _, _) in value.start_values.items():
+      for key, (source_value, type, _, _) in value.start_values.items():
         value_path = self.map_cref(systemName, str(key))
-        self.apply_start_value(value_path, source_value)
+        self.apply_start_value(value_path, source_value, type)
 
-  def apply_start_value(self, value_path:str, value):
+  def apply_start_value(self, value_path:str, value, type):
     # Determine the variable type
-    type, status = Capi.getVariableType(value_path)
-    if status != Status.ok:
-      raise RuntimeError(f"Failed to get variable type for {value_path}: {status}")
+    if type is None:
+      type, status = Capi.getVariableType(value_path)
+      if status != Status.ok:
+        raise RuntimeError(f"Failed to get variable type for {value_path}: {status}")
     ## TODO: handle FMi3 data types directly, like Float64, Int32,
     value_ = value.value if hasattr(value, 'value') else value
 
     match SignalType(type):
-      case SignalType.Real:  # oms_signal_type_real
+      case SignalType.Real | SignalType.Float32 | SignalType.Float64:  # oms_signal_type_real
         self._setReal(value_path, float(value_))
-      case SignalType.Integer:  # oms_signal_type_integer
+      case SignalType.Integer | SignalType.Int32 | SignalType.Int8 | SignalType.UInt8 | SignalType.Int16 | SignalType.UInt16 | SignalType.Int32 |SignalType.UInt32 | SignalType.Int64 | SignalType.UInt64:  # oms_signal_type_integer
         self._setInteger(value_path, int(value_))
       case SignalType.Boolean:  # oms_signal_type_boolean
         self._setBoolean(value_path, bool(value_))

src/OMSimulatorPython/ssv.py

@@ -2,7 +2,7 @@
 
 from lxml import etree as ET
 from OMSimulator.values import Values
-
+from OMSimulator.variable import SignalType
 from OMSimulator import namespace, utils
 
 
@@ -14,8 +14,8 @@ def __init__(self, ssv_path : str | None = None):
       self.filename = Path(ssv_path)
       self.importFromSSV(self.filename)
 
-  def setValue(self, cref:str, value, unit = None, description = None):
-    self.value.setValue(cref, value, unit, description)
+  def setValue(self, cref:str, value, type : SignalType | None = None, unit = None, description = None):
+    self.value.setValue(cref, value, type, unit, description)
 
   def list(self, prefix = ""):
     self.value.list(prefix)
@@ -40,5 +40,5 @@ def export(self, filename : str):
 
   def importFromSSV(self, filename):
     parameterValues = utils.parseSSV(filename)
-    for key, (value, unit, description) in parameterValues.items():
-      self.setValue(key, value, unit, description)
+    for key, (value, type, unit, description) in parameterValues.items():
+      self.setValue(key, value, type, unit, description)

src/OMSimulatorPython/system.py

@@ -304,7 +304,7 @@ def delete(self, cref: CRef):
     first = cref.first()
 
     ## Check if the cref is a top level system connector
-    if self._connectorExists(first, delete = True):
+    if self._deleteConnector(first):
       return
 
     match self.elements.get(first):
@@ -472,15 +472,19 @@ def addConnection(self, startElement : str, startConnector : str, endElement : s
     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}'")
 
-
-  def _connectorExists(self, cref: CRef, delete = False) -> bool:
+  def _connectorExists(self, cref: CRef) -> Connector | None:
     """Check if a connector exists in the system."""
+    for connector in self.connectors:
+      if connector.name == cref:
+        return connector
+    return None
+
+  def _deleteConnector(self, cref: CRef) -> bool:
+    """Delete connector if it exists."""
     for i, connector in enumerate(self.connectors):
       if connector.name == cref:
-        if delete:
-          del self.connectors[i]
-          # Remove connections associated with this connector
-          self.deleteAllConnection(cref)
+        self.deleteAllConnection(cref)
+        del self.connectors[i]
         return True
     return False
 
@@ -490,7 +494,8 @@ def _getComponentResourcePath(self, cref):
 
     ## check if element is a top level system connectors
     ## or allow non existing connectors to support parameter mapping throgh SSM inline or ssm file by checking if cref
-    if self._connectorExists(cref) or cref.is_root():
+    connector = self._connectorExists(cref)
+    if connector or cref.is_root():
       return (None, None)
 
     if element is None:
@@ -508,8 +513,10 @@ def setValue(self, cref: CRef, value, unit = None, description = None):
     first = cref.first()
     ## Check if the cref is a top level system connector
     ## or allow non existing connectors to support parameter mapping throgh SSM inline or ssm file by checking if cref
-    if self._connectorExists(first) or cref.is_root():
-      self.value.setValue(cref, value, unit)
+    connector = self._connectorExists(first)
+    if connector or cref.is_root():
+      signal_type = connector.signal_type if connector else None
+      self.value.setValue(cref, value, signal_type, unit, description)
       return
 
     match self.elements.get(first):
@@ -524,7 +531,8 @@ def getValue(self, cref: CRef):
     first = cref.first()
     ## Check if the cref is a top level system connector
     ## or allow non existing connectors to support parameter mapping throgh SSM inline or ssm file by checking if cref
-    if self._connectorExists(first) or cref.is_root():
+    connector = self._connectorExists(first)
+    if connector or cref.is_root():
       self.value.getValue(cref)
       return
 

src/OMSimulatorPython/utils.py

@@ -20,8 +20,8 @@ def _simple_warning(message, category, filename, lineno, line=None):
 
 def _setParameters(parameterValues: dict, obj):
   if len(parameterValues) > 0:
-    for key, (value, unit, description) in parameterValues.items():
-      obj.value.setValue(key, value, unit, description)
+    for key, (value, type, unit, description) in parameterValues.items():
+      obj.value.setValue(key, value, type, unit, description)
 
 def parseDefaultExperiment(node, root):
   default_experiment = node.find("ssd:DefaultExperiment", namespaces=namespace.ns)
@@ -163,6 +163,7 @@ def parseParameterBindingHelper(parameters):
                       "ssv:Integer": int,
                       "ssv:Boolean": lambda v: v.lower() == "true",  # Convert "true"/"false" to bool
                       "ssv:String": str,
+                      "ssv:Enumeration": int,
                        ## FMI-3.0 types
                       "ssv:Float64": Float64,
                       "ssv:Float32": Float32,
@@ -180,7 +181,11 @@ def parseParameterBindingHelper(parameters):
         if value_element is not None:
           value = value_element.get("value")
           unit = value_element.get("unit")
-          parameterValues[name] = (cast_func(value), unit, description)  # Convert to correct type
+           # Extract type name (remove namespace prefix)
+          type_name = value_type.split(":")[1]
+          if type_name == "Enumeration":
+            type_name = "Integer"  # Treat Enumeration as Integer for type purposes
+          parameterValues[name] = (cast_func(value), SignalType[type_name], unit, description)  # Convert to correct type
           break  # Stop after first found type
     return parameterValues
 

src/OMSimulatorPython/values.py

@@ -2,16 +2,16 @@
 from OMSimulator.unit import Unit
 from OMSimulator.ssm import SSM
 from OMSimulator import namespace
-from OMSimulator.variable import Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64
+from OMSimulator.variable import SignalType, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64
 
 class Values:
   def __init__(self):
     self.start_values = {}
 
-  def setValue(self, name, value, unit=None, description=None):
+  def setValue(self, name, value, type : SignalType | None, unit=None, description=None):
     if unit is not None and not isinstance(value, float):
       raise TypeError("Unit can only be set for Real values.")
-    self.start_values[name] = (value, unit, description)
+    self.start_values[name] = (value, type, unit, description)
 
   def getValue(self, name):
     return self.start_values.get(name)
@@ -26,8 +26,11 @@ def list(self, prefix = ""):
     if self.empty():
       return
 
-    for key, (value, unit, description) in self.start_values.items():
-      type_tag = self._getVariableType(value)
+    for key, (value, type, unit, description) in self.start_values.items():
+      if type:
+        type_tag = type.name
+      else:
+        type_tag = self._getVariableType(value)
       print(f"{prefix} ({type_tag} {key}, {str(value.value if hasattr(value, 'value') else value)}, {unit}, '{description}')")
 
   def exportToSSD(self, node, parameterMapping : SSM | None = None, unitDefinitions = None):
@@ -64,7 +67,7 @@ def exportToSSV(self, node):
 
   def add_parameters(self, parameters_node, prefix = None):
     """Generic function to add XML parameters based on the value type."""
-    for key, (value, unit, description) in self.start_values.items():
+    for key, (value, type, unit, description) in self.start_values.items():
       parameter_node = ET.SubElement(parameters_node, namespace.tag("ssv", "Parameter"))
       if prefix:
         parameter_node.set("name", str(prefix) + "." + str(key))
@@ -73,7 +76,10 @@ def add_parameters(self, parameters_node, prefix = None):
       if description:
         parameter_node.set("description", description)
 
-      type_tag = self._getVariableType(value)
+      if type:
+        type_tag = type.name
+      else:
+        type_tag = self._getVariableType(value)
 
       parameter_type = ET.SubElement(parameter_node, namespace.tag("ssv", type_tag))
       value_ = str(value.value if hasattr(value, 'value') else value)

testsuite/api/deleteResources1.py

@@ -5,7 +5,7 @@
 ## win: yes
 ## mac: yes
 
-from OMSimulator import SSP, CRef, Settings, SSV
+from OMSimulator import SSP, CRef, Settings, SSV, SignalType
 
 Settings.suppressPath = True
 
@@ -21,15 +21,15 @@
 component2 = model.addComponent(CRef('default', 'Add2'), 'resources/Add.fmu')
 
 ssv1 = SSV()
-ssv1.setValue("k1", 2.0, "m")
-ssv1.setValue("k2", 3.0, "kg")
-ssv1.setValue("param3", "hello")
+ssv1.setValue("k1", 2.0, SignalType.Real, "m")
+ssv1.setValue("k2", 3.0, SignalType.Real, "kg")
+ssv1.setValue("param3", "hello", SignalType.String)
 ssv1.export("delete3.ssv")
 
 ssv2 = SSV()
-ssv2.setValue("k1", 200.0, "m")
-ssv2.setValue("k2", 300.0, "kg")
-ssv2.setValue("param3", "ssp")
+ssv2.setValue("k1", 200.0, SignalType.Real, "m")
+ssv2.setValue("k2", 300.0, SignalType.Real, "kg")
+ssv2.setValue("param3", "ssp", SignalType.String)
 ssv2.export("delete4.ssv")
 
 ## add delete1.ssv to to ssp resources

testsuite/api/listSSVReference1.py

@@ -5,7 +5,7 @@
 ## win: yes
 ## mac: yes
 
-from OMSimulator import SSP, CRef, Settings, SSV
+from OMSimulator import SSP, CRef, Settings, SSV, SignalType
 
 Settings.suppressPath = True
 
@@ -26,15 +26,15 @@
 model.addComponent(CRef('default', 'sub-system', 'Add3'), 'resources/Add.fmu')
 
 ssv1 = SSV()
-ssv1.setValue("k1", 2.0, "m")
-ssv1.setValue("k2", 3.0, "kg")
-ssv1.setValue("param3", "hello")
+ssv1.setValue("k1", 2.0, SignalType.Real, "m")
+ssv1.setValue("k2", 3.0, SignalType.Real, "kg")
+ssv1.setValue("param3", "hello", SignalType.String)
 ssv1.export("list1.ssv")
 
 ssv2 = SSV()
-ssv2.setValue("k1", 200.0, "m")
-ssv2.setValue("k2", 300.0, "kg")
-ssv2.setValue("param3", "ssp")
+ssv2.setValue("k1", 200.0, SignalType.Real, "m")
+ssv2.setValue("k2", 300.0, SignalType.Real, "kg")
+ssv2.setValue("param3", "ssp", SignalType.String)
 ssv2.export("list2.ssv")
 
 ## add list1.ssv to to ssp resources

testsuite/api/setValueSSV1.py

@@ -5,25 +5,25 @@
 ## win: yes
 ## mac: yes
 
-from OMSimulator import SSP, CRef, Settings, SSV
+from OMSimulator import SSP, CRef, Settings, SSV, SignalType
 
 Settings.suppressPath = True
 
 # This example creates a new SSV file and set some parameter values and export it to filesystem
 
 ssv1 = SSV()
-ssv1.setValue("k1", 2.0, "m")
-ssv1.setValue("k2", 3.0)
-ssv1.setValue("k3", 3)
-ssv1.setValue("k4", False)
-ssv1.setValue("param3", "hello")
+ssv1.setValue("k1", 2.0, SignalType.Real, "m")
+ssv1.setValue("k2", 3.0, SignalType.Real)
+ssv1.setValue("k3", 3, SignalType.Integer)
+ssv1.setValue("k4", False, SignalType.Boolean)
+ssv1.setValue("param3", "hello", SignalType.String)
 ssv1.export("myfile1.ssv")
 
 
 ssv2 = SSV()
-ssv2.setValue("k1", 20.0, "m")
-ssv2.setValue("k2", 30.0, "kg")
-ssv2.setValue("param3", "helloSSP")
+ssv2.setValue("k1", 20.0, SignalType.Real, "m")
+ssv2.setValue("k2", 30.0, SignalType.Real, "kg")
+ssv2.setValue("param3", "helloSSP", SignalType.String)
 ssv2.export("myfile2.ssv")
 
 files = ["myfile1.ssv", "myfile2.ssv"]

testsuite/api/setValueSSV2.py

@@ -5,7 +5,7 @@
 ## win: yes
 ## mac: yes
 
-from OMSimulator import SSP, CRef, Settings, SSV
+from OMSimulator import SSP, CRef, Settings, SSV, SignalType
 
 Settings.suppressPath = True
 
@@ -19,15 +19,15 @@
 component2 = model.addComponent(CRef('default', 'Add2'), 'resources/Add.fmu')
 
 ssv1 = SSV()
-ssv1.setValue("k1", 2.0, "m")
-ssv1.setValue("k2", 3.0, "kg")
-ssv1.setValue("param3", "hello")
+ssv1.setValue("k1", 2.0, SignalType.Real, "m")
+ssv1.setValue("k2", 3.0, SignalType.Real, "kg")
+ssv1.setValue("param3", "hello", SignalType.String)
 ssv1.export("myfile3.ssv")
 
 ssv2 = SSV()
-ssv2.setValue("k1", 200.0, "m")
-ssv2.setValue("k2", 300.0, "kg")
-ssv2.setValue("param3", "ssp")
+ssv2.setValue("k1", 200.0, SignalType.Real, "m")
+ssv2.setValue("k2", 300.0, SignalType.Real, "kg")
+ssv2.setValue("param3", "ssp", SignalType.String)
 ssv2.export("myfile4.ssv")
 
 ## add myfile1.ssv to to ssp resources