Merge branch 'master' of github.com:INTO-CPS-Association/unifmu

Author: DisasterlyDisco

assets/csharp/model.cs

@@ -8,18 +8,18 @@
 
 public class Model
 {
-    public double real_a { get; set; } = 0.0f;
-    public double real_b { get; set; } = 0.0f;
-    public double real_c { get; set; } = 0.0f;
-    public int integer_a { get; set; } = 0;
-    public int integer_b { get; set; } = 0;
-    public int integer_c { get; set; } = 0;
-    public bool boolean_a { get; set; } = false;
-    public bool boolean_b { get; set; } = false;
-    public bool boolean_c { get; set; } = false;
-    public string string_a { get; set; } = "";
-    public string string_b { get; set; } = "";
-    public string string_c { get; set; } = "";
+    public double real_a { get; set; }
+    public double real_b { get; set; }
+    public double real_c { get; set; }
+    public int integer_a { get; set; }
+    public int integer_b { get; set; }
+    public int integer_c { get; set; }
+    public bool boolean_a { get; set; }
+    public bool boolean_b { get; set; }
+    public bool boolean_c { get; set; }
+    public string string_a { get; set; }
+    public string string_b { get; set; }
+    public string string_c { get; set; }
 
     private Dictionary<uint, PropertyInfo> reference_to_attributes = new Dictionary<uint, PropertyInfo>();
 
@@ -42,7 +42,9 @@ public Model()
       { 11, this.GetType().GetProperty("string_c") },
     };
 
+    Fmi2Reset();
     }
+    
     public Fmi2Status Fmi2DoStep(double currentTime, double stepSize, bool noStepPrior)
     {
         UpdateOutputs();
@@ -118,6 +120,16 @@ public Fmi2Status Fmi2CancelStep()
 
     public Fmi2Status Fmi2Reset()
     {
+        this.real_a = 0;
+        this.real_b = 0;
+        this.integer_a = 0;
+        this.integer_b = 0;
+        this.boolean_a = false;
+        this.boolean_b = false;
+        this.string_a = "";
+        this.string_b = "";
+        this.UpdateOutputs();
+
         return Fmi2Status.Fmi2Ok;
     }
 

assets/java/src/main/java/Model.java

@@ -9,18 +9,18 @@
 
 public class Model {
 
-    public Double real_a = 0.0;
-    public Double real_b = 0.0;
-    public Double real_c = 0.0;
-    public Integer integer_a = 0;
-    public Integer integer_b = 0;
-    public Integer integer_c = 0;
-    public Boolean boolean_a = false;
-    public Boolean boolean_b = false;
-    public Boolean boolean_c = false;
-    public String string_a = "";
-    public String string_b = "";
-    public String string_c = "";
+    public Double real_a;
+    public Double real_b;
+    public Double real_c;
+    public Integer integer_a;
+    public Integer integer_b;
+    public Integer integer_c;
+    public Boolean boolean_a;
+    public Boolean boolean_b;
+    public Boolean boolean_c;
+    public String string_a;
+    public String string_b;
+    public String string_c;
 
     private ArrayList<Field> references_to_attributes;
 
@@ -41,6 +41,7 @@ public Model() throws Exception {
         this.references_to_attributes.add(this.getClass().getField("string_b"));
         this.references_to_attributes.add(this.getClass().getField("string_c"));
 
+        fmi2Reset();
     }
 
     public Fmi2Status fmi2DoStep(double current_time, double step_size, boolean noStepPrior) {
@@ -105,17 +106,15 @@ public Fmi2Status fmi2SetupExperiment(double start_time, Double stop_time, Doubl
 
     public Fmi2Status fmi2Reset() {
         this.real_a = 0.0;
-        this.real_c = 0.0;
-        this.integer_a = 0;
         this.real_b = 0.0;
+        this.integer_a = 0;
         this.integer_b = 0;
-        this.integer_c = 0;
         this.boolean_a = false;
         this.boolean_b = false;
-        this.boolean_c = false;
         this.string_a = "";
         this.string_b = "";
-        this.string_c = "";
+        update_outputs();
+
         return Fmi2Status.OK;
     }
 

assets/python/fmi2/model.py

@@ -3,6 +3,7 @@
 
 class Model:
     def __init__(self) -> None:
+
         self.real_a = 0.0
         self.real_b = 0.0
         self.integer_a = 0
@@ -27,7 +28,7 @@ def __init__(self) -> None:
             11: "string_c",
         }
 
-        self._update_outputs()
+        self.fmi2Reset()
 
     # ================= FMI2 =================
 
@@ -54,19 +55,33 @@ def fmi2Terminate(self):
         return Fmi2Status.ok
 
     def fmi2Reset(self):
+        self.real_a = 0.0
+        self.real_b = 0.0
+        self.integer_a = 0
+        self.integer_b = 0
+        self.boolean_a = False
+        self.boolean_b = False
+        self.string_a = ""
+        self.string_b = ""
+        self._update_outputs()
+
         return Fmi2Status.ok
 
     def fmi2SerializeFmuState(self):
         bytes = pickle.dumps(
             (
                 self.real_a,
                 self.real_b,
+                self.real_c,
                 self.integer_a,
                 self.integer_b,
+                self.integer_c,
                 self.boolean_a,
                 self.boolean_b,
+                self.boolean_c,
                 self.string_a,
                 self.string_b,
+                self.string_c,
             )
         )
         return Fmi2Status.ok, bytes
@@ -75,22 +90,29 @@ def fmi2DeserializeFmuState(self, bytes):
         (
             real_a,
             real_b,
+            real_c,
             integer_a,
             integer_b,
+            integer_c,
             boolean_a,
             boolean_b,
+            boolean_c,
             string_a,
             string_b,
+            string_c,
         ) = pickle.loads(bytes)
         self.real_a = real_a
         self.real_b = real_b
+        self.real_c = real_c
         self.integer_a = integer_a
         self.integer_b = integer_b
+        self.integer_c = integer_c
         self.boolean_a = boolean_a
         self.boolean_b = boolean_b
+        self.boolean_c = boolean_c
         self.string_a = string_a
         self.string_b = string_b
-        self._update_outputs()
+        self.string_c = string_c
 
         return Fmi2Status.ok
 

cli/tests/common/mod.rs

@@ -524,11 +524,11 @@ impl BreakableFmu for LocalFmu {
 
     fn do_step_function_line_number(&self) -> u64 {
         match self.language() {
-            FmuBackendImplementationLanguage::CSharp => 48,
+            FmuBackendImplementationLanguage::CSharp => 50,
             FmuBackendImplementationLanguage::Java => 47,
             FmuBackendImplementationLanguage::Python => {
                 match self.version() {
-                    FmiVersion::Fmi2 => 37,
+                    FmiVersion::Fmi2 => 38,
                     FmiVersion::Fmi3 => 116
                 }
             },

cli/tests/python_tests/fmu_tests.py

@@ -153,34 +153,35 @@ def inner(fmu, model_description):
         assert strings == ["", "", ""], f"Initially fetched values were {strings}, should have been ['', '', '']"
 
         print("Fetching FMU state")
-        state = fmu.getFMUstate()
+        initial_state = fmu.getFMUstate()
         rerolled_time = sim_time
 
         print(f"Updating inputs at time {sim_time}")
         fmu.setReal([vrs["real_a"],vrs["real_b"]],[1.0,2.0])
         fmu.setInteger([vrs["integer_a"],vrs["integer_b"]],[1,2])
         fmu.setBoolean([vrs["boolean_a"],vrs["boolean_b"]],[True,False])
         fmu.setString([vrs["string_a"],vrs["string_b"]],["Hello, ","World!"])
+        updated_state = fmu.getFMUstate() 
 
         print(f"Doing a step of size {step_size} at time {sim_time}")
-        fmu.doStep(sim_time, step_size) == fmi2OK, f"doStep returned with error , should have been return value: {fmi2OK}"
+        fmu.doStep(sim_time, step_size) == fmi2OK, f"doStep returned with error, should have been return value: {fmi2OK}"
         sim_time += step_size
 
-
         print("Fetching evolved values")
-        real_c = fmu.getReal([vrs["real_c"]])[0]
-        integer_c = fmu.getInteger([vrs["integer_c"]])[0]
-        boolean_c = fmu.getBoolean([vrs["boolean_c"]])[0]
-        string_c = fmu.getString([vrs["string_c"]])[0].decode("utf-8")
+        reals = fmu.getReal([vrs["real_a"], vrs["real_b"],vrs["real_c"]])
+        integers = fmu.getInteger([vrs["integer_a"], vrs["integer_b"], vrs["integer_c"]])
+        booleans = fmu.getBoolean([vrs["boolean_a"], vrs["boolean_b"], vrs["boolean_c"]])
+        strings = fmu.getString([vrs["string_a"], vrs["string_b"], vrs["string_c"]])
+        strings = [string.decode("utf-8")  for string in strings]
 
         print("Asserting evolved values")
-        assert real_c == 3.0, f"Evolved value real_c was {real_c}, should have been 0.0"
-        assert integer_c == 3, f"Evolved value integer_c was {integer_c}, should have been 0"
-        assert boolean_c == True, f"Evolved value boolean_c was {boolean_c}, should have been True"
-        assert string_c == "Hello, World!", f"Evolved value string_c was '{string_c}', should have been 'Hello, World!'"
+        assert reals == [1.0, 2.0, 3.0], f"Evolved value real_c was {reals}, should have been [1.0, 2.0, 3.0]"
+        assert integers == [1, 2, 3], f"Evolved value integer_c was {integers}, should have been [1, 2, 3]"
+        assert booleans == [True, False, True], f"Evolved value boolean_c was {booleans}, should have been [True, False, True]"
+        assert strings == ["Hello, ", "World!", "Hello, World!"], f"Evolved value string_c was '{strings}', should have been [Hello, , World!, Hello, World!]"
 
         print("Rerolling FMU state")
-        fmu.setFMUstate(state)
+        fmu.setFMUstate(initial_state)
         print("Resetting time")
         sim_time = rerolled_time
 
@@ -197,10 +198,11 @@ def inner(fmu, model_description):
         assert bools == [False, False, False], f"Rerolled values were {bools}, should have been [False, False, False]"
         assert strings == ["", "", ""], f"Rerolled values were {strings}, should have been ['', '', '']"
 
-        print("Will doStep and then reset FMU")
+        print("Testing reset")
+        fmu.setFMUstate(updated_state)
         fmu.doStep(sim_time, step_size) == fmi2OK, f"doStep returned with error, should have been return value: {fmi2OK}"
         sim_time += step_size
-
+    
         assert fmu.reset() == fmi2OK, f"reset returned with error, should have been return value: {fmi2OK}" 
         # setupExperiment and enterInitializationMode has to be called after reset()
         assert fmu.setupExperiment(startTime=start_time) == fmi2OK, f"setupExperiment returned with error, should have been return value: {fmi2OK}"
@@ -212,17 +214,17 @@ def inner(fmu, model_description):
         integers = fmu.getInteger([vrs["integer_a"], vrs["integer_b"], vrs["integer_c"]])
         bools = fmu.getBoolean([vrs["boolean_a"], vrs["boolean_b"], vrs["boolean_c"]])
         strings = fmu.getString([vrs["string_a"], vrs["string_b"], vrs["string_c"]])
-        # We need to decode strings from bytes to utf-8
         strings = [string.decode("utf-8")  for string in strings]
 
         print("Asserting values after reset")
-        assert reals == [0.0, 0.0, 0.0], f"Initially fetched values were {reals}, should have been [0.0, 0.0, 0.0]"
+        assert reals == [0.0, 0.0, 0.0], f"Initially fetched values were {reals}, cshould have been [0.0, 0.0, 0.0]"
         assert integers == [0, 0, 0], f"Initially fetched values were {integers}, should have been [0, 0, 0]"
         assert bools == [False, False, False], f"Initially fetched values were {bools}, should have been [False, False, False]"
         assert strings == ["", "", ""], f"Initially fetched values were {strings}, should have been ['', '', '']"
 
-        print(f"Test is done - freeing FMU state")
-        fmu.freeFMUState(state)
+        print(f"Test is done - freeing FMU states")
+        fmu.freeFMUState(initial_state)
+        fmu.freeFMUState(updated_state)
         print("FMU state freed successfully") 
         print("fmi2_simulate: Test Complete")
 

fmiapi/src/fmi2.rs

@@ -1377,8 +1377,15 @@ pub extern "C" fn fmi2FreeFMUstate(
 
 /// Copies the state of a slave into a buffer provided by the environment
 ///
-/// Oddly, the length of the buffer is also provided,
-/// as i would expect the environment to have enquired about the state size by calling fmi2SerializedFMUstateSize.
+/// # Parameters 
+/// - `slave`: A reference to the FMU slave instance
+/// - `state`: A reference to the state of the FMU
+/// - `data`: A pointer to the buffer where the state will be copied
+/// - `size`: The size of the buffer
+///
+/// # Returns
+/// - `Fmi2Status::Ok`: If the operation succeeds and the FMU state is successfully serialized and stored.
+/// - `Fmi2Status::Error`: If an error occurs during the serialization or if invalid pointers are provided.
 #[no_mangle]
 /// We assume that the buffer is sufficiently large
 pub extern "C" fn fmi2SerializeFMUstate(
@@ -1452,6 +1459,16 @@ pub unsafe extern "C" fn fmi2DeSerializeFMUstate(
     Fmi2Status::Ok
 }
 
+/// Retrieves the size of the serialized state of the FMU
+///
+/// # Parameters
+/// - `slave`: A reference to the FMU slave instance
+/// - `state`: A reference to the state of the FMU
+/// - `size`: A reference to the size of the serialized state
+///
+/// # Returns
+/// - `Fmi2Status::Ok`: If the operation succeeds and the size of the serialized state is successfully retrieved.
+
 #[no_mangle]
 pub extern "C" fn fmi2SerializedFMUstateSize(
     slave: &Fmi2Slave,