Offline model building: system_structure and related functionality (#542

)

include/cse/exception.hpp

@@ -42,6 +42,9 @@ enum class errc
     /// Simulation error
     simulation_error,
 
+    /// Invalid system structure (e.g. an invalid variable connection)
+    invalid_system_structure,
+
     /// ZIP file error
     zip_error
 };

include/cse/execution.hpp

@@ -8,13 +8,15 @@
 #include <cse/async_slave.hpp>
 #include <cse/function/function.hpp>
 #include <cse/model.hpp>
+#include <cse/system_structure.hpp>
 
 #include <boost/fiber/future.hpp>
 #include <boost/functional/hash.hpp>
 
 #include <memory>
 #include <optional>
 #include <sstream>
+#include <unordered_map>
 
 
 namespace cse
@@ -311,5 +313,32 @@ class execution
 };
 
 
+/// Maps entity names to simulator/function indices in an `execution`.
+struct entity_index_maps
+{
+    /// Mapping of simulator names to simulator indices.
+    std::unordered_map<std::string, simulator_index> simulators;
+
+    /// Mapping of function names to function indices.
+    std::unordered_map<std::string, function_index> functions;
+};
+
+
+/**
+ *  Adds simulators and connections to an execution, and sets initial values,
+ *  according to a predefined system structure description.
+ *
+ *  This function may be called multiple times for the same `execution`, as
+ *  long as there is no conflict between the different `system_structure`
+ *  objects.
+ *
+ *  \returns
+ *      Mappings between entity names and their indexes in the execution.
+ */
+entity_index_maps inject_system_structure(
+    execution& exe,
+    const system_structure& sys,
+    const variable_value_map& initialValues);
+
 } // namespace cse
 #endif // header guard

include/cse/function/utility.hpp

@@ -54,5 +54,18 @@ T get_function_parameter(
 }
 
 
+/**
+ *  Returns a `function_description` with the same contents as the
+ *  `function_description` part of `functionTypeDescription`, but with
+ *  all placeholders replaced by actual parameter values.
+ *
+ *  The `parameterValues` map *must* contain values for all placeholders
+ *  in `functionTypeDescription`.  Otherwise, an exception is thrown.
+ */
+function_description substitute_function_parameters(
+    const function_type_description& functionTypeDescription,
+    const function_parameter_value_map& parameterValues);
+
+
 } // namespace cse
 #endif // header guard