C/Python scenario rework (#77)

Author: markaren

ecospy/EcosSimulation.py

@@ -173,6 +173,72 @@ def remove_listener(self, name: str):
         """
         self._remove_listener(self.sim, name.encode())
 
+    def add_scenario(self, scenario_config: str = None, real_actions: list[tuple] = None, integer_actions: list[tuple]  = None,
+                     boolean_actions: list[tuple]  = None,
+                     string_actions: list[tuple] =None):
+        """
+        Add a scenario to the simulation.
+        Args:
+            scenario_config (str, optional): Optional scenario configuration XML file.
+            real_actions (list of tuples): List of real actions as (time_point, identifier, value).
+            integer_actions (list of tuples): List of integer actions as (time_point, identifier, value).
+            boolean_actions (list of tuples): List of boolean actions as (time_point, identifier, value).
+            string_actions (list of tuples): List of string actions as (time_point, identifier, value).
+        """
+
+        listener = None
+        if scenario_config is not None:
+            load_scenario = dll.ecos_scenario_load
+            load_scenario.argtypes = [c_char_p]
+            load_scenario.restype = c_void_p
+            listener = load_scenario(str.encode("utf-8"))
+
+        else:
+            create_scenario = dll.ecos_scenario_create
+            create_scenario.restype = c_void_p
+            listener = create_scenario()
+
+        if listener is None:
+            raise ValueError("Unable to create/load scenario: " + EcosLib.get_last_error())
+
+        if real_actions is not None:
+            for action in real_actions:
+                scenario_add_real_action = dll.ecos_scenario_add_real_action
+                scenario_add_real_action.argtypes = [c_void_p, c_double, c_char_p, c_double]
+                scenario_add_real_action.restype = c_bool
+
+                time_point, identifier, value = action
+                scenario_add_real_action(listener, time_point, identifier.encode("utf-8"), value)
+
+        if integer_actions is not None:
+            for action in integer_actions:
+                scenario_add_integer_action = dll.ecos_scenario_add_real_action
+                scenario_add_integer_action.argtypes = [c_void_p, c_double, c_char_p, c_int]
+                scenario_add_integer_action.restype = c_bool
+
+                time_point, identifier, value = action
+                scenario_add_integer_action(listener, time_point, identifier.encode("utf-8"), value)
+
+        if boolean_actions is not None:
+            for action in boolean_actions:
+                scenario_add_boolean_action = dll.ecos_scenario_add_real_action
+                scenario_add_boolean_action.argtypes = [c_void_p, c_double, c_char_p, c_bool]
+                scenario_add_boolean_action.restype = c_bool
+
+                time_point, identifier, value = action
+                scenario_add_boolean_action(listener, time_point, identifier.encode("utf-8"), value)
+
+        if string_actions is not None:
+            for action in string_actions:
+                scenario_add_string_action = dll.ecos_scenario_add_real_action
+                scenario_add_string_action.argtypes = [c_void_p, c_double, c_char_p, c_char_p]
+                scenario_add_string_action.restype = c_bool
+
+                time_point, identifier, value = action
+                scenario_add_string_action(listener, time_point, identifier.encode("utf-8"), value.encode("utf-8"))
+
+        self._add_listener(self.sim, b'scenario', listener)
+
     def add_csv_writer(self, result_file: str, csv_config: str = None, identifiers: list[str] = None,
                        decimation_factor: int = None):
         """
@@ -208,21 +274,6 @@ def add_csv_writer(self, result_file: str, csv_config: str = None, identifiers:
 
         self._add_listener(self.sim, b'csv_writer', listener)
 
-    def load_scenario(self, scenario_file: str):
-        """
-        Load a scenario file into the simulation.
-        Args:
-            scenario_file (str): Path to the scenario file to load.
-        Raises:
-            Exception: If loading the scenario fails in the underlying library.
-        """
-        _load_scenario = dll.ecos_simulation_load_scenario
-        _load_scenario.argtypes = [c_void_p, c_char_p]
-        _load_scenario.restype = c_bool
-
-        if not _load_scenario(self.sim, scenario_file.encode()):
-            raise Exception(EcosLib.get_last_error())
-
     def get_integer(self, identifier: str):
         val = c_int()
         if not self._get_integer(self.sim, identifier.encode(), byref(val)):

include/ecos/ecos.h

@@ -6,9 +6,9 @@
 
 /* Visibility macros */
 #if defined(_WIN32) || defined(__CYGWIN__)
-    #define LIBECOS_API __declspec(dllexport)
+#    define LIBECOS_API __declspec(dllexport)
 #else
-    #define LIBECOS_API __attribute__((visibility("default")))
+#    define LIBECOS_API __attribute__((visibility("default")))
 #endif
 
 #ifdef __cplusplus
@@ -75,7 +75,6 @@ LIBECOS_API bool ecos_simulation_terminate(ecos_simulation_t* sim);
 LIBECOS_API bool ecos_simulation_reset(ecos_simulation_t* sim);
 LIBECOS_API void ecos_simulation_destroy(ecos_simulation_t* sim);
 
-LIBECOS_API bool ecos_simulation_load_scenario(ecos_simulation_t* sim, const char* scenario_file);
 // -------------
 
 // simulation_runner
@@ -101,12 +100,21 @@ typedef struct ecos_simulation_listener_config
 
 LIBECOS_API ecos_simulation_listener_t* ecos_simulation_listener_create(ecos_simulation_listener_config config);
 
+//Note: this function transfers ownership of listener to simulation
 LIBECOS_API void ecos_simulation_add_listener(ecos_simulation_t* sim, const char* name, ecos_simulation_listener_t* listener);
 LIBECOS_API void ecos_simulation_remove_listener(ecos_simulation_t* sim, const char* name);
+
 LIBECOS_API ecos_simulation_listener_t* ecos_csv_writer_create(const char* resultFile, const char* csvConfig = nullptr);
 LIBECOS_API bool ecos_csv_writer_set_decimation_factor(ecos_simulation_listener_t* writer, int decimationFactor);
 LIBECOS_API bool ecos_csv_writer_register_variable(ecos_simulation_listener_t* writer, const char* identifier);
 
+LIBECOS_API ecos_simulation_listener_t* ecos_scenario_create();
+LIBECOS_API ecos_simulation_listener_t* ecos_scenario_load(const char* scenario_file);
+LIBECOS_API bool ecos_scenario_add_int_action(ecos_simulation_listener_t* s, double timePoint, const char* identifier, int value, double eps = 1e-9);
+LIBECOS_API bool ecos_scenario_add_real_action(ecos_simulation_listener_t* s, double timePoint, const char* identifier, double value, double eps = 1e-9);
+LIBECOS_API bool ecos_scenario_add_bool_action(ecos_simulation_listener_t* s, double timePoint, const char* identifier, bool value, double eps = 1e-9);
+LIBECOS_API bool ecos_scenario_add_string_action(ecos_simulation_listener_t* s, double timePoint, const char* identifier, const char* value, double eps = 1e-9);
+
 LIBECOS_API void ecos_plot_csv(const char* csvFile, const char* chartConfig);
 // -------------
 

src/ecos/ecos.cpp

@@ -52,6 +52,7 @@ struct ecos_parameter_set
     ecos::parameter_set cpp_parameter_set;
 };
 
+
 void handle_current_exception()
 {
     try {
@@ -565,18 +566,6 @@ ecos_simulation_listener_t* ecos_simulation_listener_create(ecos_simulation_list
     return l.release();
 }
 
-bool ecos_simulation_load_scenario(ecos_simulation_t* sim, const char* scenario_file)
-{
-    try {
-        auto scenario = ecos::scenario::load(scenario_file);
-        sim->cpp_sim->add_listener("scenario", std::move(scenario));
-        return true;
-    } catch (...) {
-        handle_current_exception();
-        return false;
-    }
-}
-
 ecos_simulation_runner_t* ecos_simulation_runner_create(ecos_simulation_t* sim)
 {
     auto runner = std::make_unique<ecos_simulation_runner_t>(sim);
@@ -606,3 +595,80 @@ void ecos_simulation_runner_destroy(const ecos_simulation_runner_t* runner)
         runner = nullptr;
     }
 }
+
+ecos_simulation_listener_t* ecos_scenario_create()
+{
+    try {
+        auto scenario = std::make_unique<ecos_simulation_listener_t>();
+        scenario->cpp_listener = std::make_unique<ecos::scenario>();
+        return scenario.release();
+    } catch (...) {
+        handle_current_exception();
+        return nullptr;
+    }
+}
+
+
+ecos_simulation_listener* ecos_scenario_load(const char* scenario_file)
+{
+    try {
+        auto scenario = std::make_unique<ecos_simulation_listener>();
+        scenario->cpp_listener = ecos::scenario::load(scenario_file);
+        return scenario.release();
+    } catch (...) {
+        handle_current_exception();
+        return nullptr;
+    }
+}
+
+bool ecos_scenario_add_int_action(ecos_simulation_listener* s, double timePoint, const char* identifier, int value, double eps)
+{
+    try {
+        auto scenario = dynamic_cast<ecos::scenario*>(s->cpp_listener.get());
+        scenario->add_action<int>(timePoint, identifier, value, eps);
+        return true;
+
+    } catch (...) {
+        handle_current_exception();
+        return false;
+    }
+}
+
+bool ecos_scenario_add_real_action(ecos_simulation_listener* s, double timePoint, const char* identifier, double value, double eps)
+{
+    try {
+        auto scenario = dynamic_cast<ecos::scenario*>(s->cpp_listener.get());
+        scenario->add_action<double>(timePoint, identifier, value, eps);
+        return true;
+
+    } catch (...) {
+        handle_current_exception();
+        return false;
+    }
+}
+
+bool ecos_scenario_add_bool_action(ecos_simulation_listener* s, double timePoint, const char* identifier, bool value, double eps)
+{
+    try {
+        auto scenario = dynamic_cast<ecos::scenario*>(s->cpp_listener.get());
+        scenario->add_action<bool>(timePoint, identifier, value, eps);
+        return true;
+
+    } catch (...) {
+        handle_current_exception();
+        return false;
+    }
+}
+
+bool ecos_scenario_add_string_action(ecos_simulation_listener* s, double timePoint, const char* identifier, const char* value, double eps)
+{
+    try {
+        auto scenario = dynamic_cast<ecos::scenario*>(s->cpp_listener.get());
+        scenario->add_action<std::string>(timePoint, identifier, value, eps);
+        return true;
+
+    } catch (...) {
+        handle_current_exception();
+        return false;
+    }
+}