support building for multiple fmi versions in the same cmake build

markaren · markaren · commit 97cc592a1112 · 2025-11-05T22:20:13.000+01:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -18,7 +18,7 @@ set(CMAKE_CXX_STANDARD 17)
 ############modelIdentifier and export version###########
 
 set(modelIdentifier identity) # <-- CHANGE ME
-set(fmi_version "fmi2") # fmi2 and fmi3 is supported
+set(fmi_version "fmi2" "fmi3") # fmi2 and fmi3 is supported
 
 ########################################################
 
diff --git a/cmake/generate_fmu.cmake b/cmake/generate_fmu.cmake
@@ -18,10 +18,24 @@ function(generateFMU modelIdentifier)
     # Expect the user to provide modelIdentifier as an OBJECT library.
     # We will build per-version shared libraries from those object files.
     set(COMMON_OBJECTS "$<TARGET_OBJECTS:fmu4cpp_base>")
+    target_include_directories(${modelIdentifier} PUBLIC "${PROJECT_SOURCE_DIR}/export/include")
 
 
     foreach (fmiVersion IN LISTS FMU_FMI_VERSIONS)
 
+        # versioned shared library target built from object libraries
+        set(versionTarget "${modelIdentifier}_${fmiVersion}")
+
+        set(FMU4CPP_MODEL_IDENTIFIER "${versionTarget}")
+        set(model_identifier_src "${generatedSourcesDir}/fmu4cpp/model_identifier_${versionTarget}.cpp")
+        configure_file(
+                "${PROJECT_SOURCE_DIR}/export/src/fmu4cpp/model_identifier.cpp.in"
+                "${model_identifier_src}"
+                @ONLY
+        )
+
+        set(VERSION_OBJECTS "${model_identifier_src}")
+
         set(TARGET_PLATFORM)
         if (fmiVersion STREQUAL "fmi2")
 
@@ -39,7 +53,7 @@ function(generateFMU modelIdentifier)
                 set(TARGET_PLATFORM linux${BITNESS})
             endif ()
 
-            set(VERSION_OBJECTS "$<TARGET_OBJECTS:fmu4cpp_fmi2>")
+            list(APPEND VERSION_OBJECTS "$<TARGET_OBJECTS:fmu4cpp_fmi2>")
             set(VERSION_DEFS FMI2)
 
         elseif (fmiVersion STREQUAL "fmi3")
@@ -57,7 +71,7 @@ function(generateFMU modelIdentifier)
                 set(TARGET_PLATFORM ${TARGET_PLATFORM}-linux)
             endif ()
 
-            set(VERSION_OBJECTS "$<TARGET_OBJECTS:fmu4cpp_fmi3>")
+            list(APPEND VERSION_OBJECTS "$<TARGET_OBJECTS:fmu4cpp_fmi3>")
             set(VERSION_DEFS FMI3)
 
         else ()
@@ -70,18 +84,13 @@ function(generateFMU modelIdentifier)
         set(binaryOutputDir "${modelOutputDir}/binaries/${TARGET_PLATFORM}")
 
 
-        # versioned shared library target built from object libraries
-        set(versionTarget "${modelIdentifier}_${fmiVersion}")
         add_library(${versionTarget} SHARED
                 ${COMMON_OBJECTS}
                 "$<TARGET_OBJECTS:${modelIdentifier}>"
                 ${VERSION_OBJECTS}
         )
-
-
+        target_include_directories(${versionTarget} PRIVATE "${PROJECT_SOURCE_DIR}/export/include")
         target_compile_definitions(${versionTarget} PRIVATE ${VERSION_DEFS})
-        target_compile_definitions(${modelIdentifier} PUBLIC FMU4CPP_MODEL_IDENTIFIER=\"${versionTarget}\")
-        target_include_directories(${modelIdentifier} PUBLIC "${PROJECT_SOURCE_DIR}/export/include")
 
 
         if (WIN32)
@@ -100,27 +109,24 @@ function(generateFMU modelIdentifier)
         # Generate modelDescription.xml
         add_custom_command(TARGET ${versionTarget} POST_BUILD
                 WORKING_DIRECTORY "${fmuOutputDir}"
-                COMMAND ${CMAKE_COMMAND} -E echo "Generating modelDescription.xml for ${versionTarget}"
-                COMMAND descriptionGenerator ${modelIdentifier} "${binaryOutputDir}/$<TARGET_FILE_NAME:${versionTarget}>"
-                VERBATIM
-        )
+                COMMAND ${CMAKE_COMMAND} -E echo "[generateFMU-${fmiVersion}] Generating modelDescription.xml for model '${modelIdentifier}'"
+                COMMAND descriptionGenerator ${modelIdentifier} "${binaryOutputDir}/$<TARGET_FILE_NAME:${versionTarget}>")
 
         if (FMU_RESOURCE_FOLDER STREQUAL "")
             add_custom_command(TARGET ${versionTarget} POST_BUILD
                     WORKING_DIRECTORY "${modelOutputDir}"
                     COMMAND ${CMAKE_COMMAND} -E tar "c" "${modelIdentifier}.fmu" --format=zip
                     "${modelOutputDir}/binaries"
-                    "${modelOutputDir}/modelDescription.xml"
-                    VERBATIM)
+                    "${modelOutputDir}/modelDescription.xml")
 
         else ()
-            message("[generateFMU-${fmiVersion}] Using resourceFolder=${FMU_RESOURCE_FOLDER} for model with identifier='${modelIdentifier}'")
+            message("[generateFMU-${fmiVersion}] Using resourceFolder=${FMU_RESOURCE_FOLDER} for model '${modelIdentifier}'")
 
             file(COPY "${FMU_RESOURCE_FOLDER}/" DESTINATION "${modelOutputDir}/resources")
 
             add_custom_command(TARGET ${versionTarget} POST_BUILD
                     WORKING_DIRECTORY "${modelOutputDir}"
-                    COMMAND ${CMAKE_COMMAND} -E echo "Packaging ${modelIdentifier}.fmu in ${modelOutputDir}"
+                    COMMAND ${CMAKE_COMMAND} -E echo "[generateFMU-${fmiVersion}] Packaging ${modelIdentifier}.fmu in ${modelOutputDir}"
                     COMMAND ${CMAKE_COMMAND} -E tar "c" "${modelIdentifier}.fmu" --format=zip
                     "resources"
                     "${modelOutputDir}/binaries"
diff --git a/export/descriptionGenerator.cpp b/export/descriptionGenerator.cpp
@@ -68,7 +68,7 @@ int main(int argc, char **argv) {
     const auto handle = load_library(libName);
 
     if (!handle) {
-        const auto err = "Unable to load dynamic library '" + libName + "'! " + getLastError();
+        const auto err = "[fmu4cpp modelDescription generator] Unable to load dynamic library '" + libName + "'! " + getLastError();
         std::cerr << err << std::endl;
         return 1;
     }
diff --git a/export/examples/BouncingBall/bouncing_ball.cpp b/export/examples/BouncingBall/bouncing_ball.cpp
@@ -80,7 +80,6 @@ model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "BouncingBall";
     info.description = "A bouncing ball model";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return info;
 }
 
diff --git a/export/examples/Resource/resource.cpp b/export/examples/Resource/resource.cpp
@@ -43,7 +43,6 @@ model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "Resource";
     info.description = "A model with resources";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return info;
 }
 
diff --git a/export/examples/SimplePendulum/simple_pendulum.cpp b/export/examples/SimplePendulum/simple_pendulum.cpp
@@ -63,7 +63,6 @@ model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "SimplePendulum";
     info.description = "A simple pendulum model";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     info.vendorAnnotations = {"<Tool name=\"fmu4cpp\">\n\t<documentation>\"Example of tool specific annotation data\"</documentation>\n</Tool>"};
     return info;
 }
diff --git a/export/examples/VanDerPol/van_der_pol.cpp b/export/examples/VanDerPol/van_der_pol.cpp
@@ -80,7 +80,6 @@ model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "VanDerPol";
     info.description = "VanDerPol oscillator";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     info.defaultExperiment = {0.0, 20};
     return info;
 }
diff --git a/export/include/fmu4cpp/model_info.hpp b/export/include/fmu4cpp/model_info.hpp
@@ -3,9 +3,13 @@
 #define FMU4CPP_TEMPLATE_MODEL_INFO_HPP
 
 #include <string>
+#include <optional>
+#include <vector>
 
 namespace fmu4cpp {
 
+    std::string model_identifier();
+
     struct default_experiment final {
         double startTime{0.0};
         std::optional<double> stopTime;
@@ -17,7 +21,6 @@ namespace fmu4cpp {
         std::string modelName;
         std::string author;
         std::string description;
-        std::string modelIdentifier;
         std::string version;
         std::string variableNamingConvention{"structured"};
         std::vector<std::string> vendorAnnotations;
diff --git a/export/src/fmu4cpp/fmi2/fmi2.cpp b/export/src/fmu4cpp/fmi2/fmi2.cpp
@@ -76,7 +76,7 @@ const char *fmi2GetVersion(void) {
     return "2.0";
 }
 
-FMI2_Export void write_description(const char *location) {
+FMI2_Export void write_description(const char *location, const char* modelIdentifier) {
     const auto instance = fmu4cpp::createInstance({});
     const auto xml = instance->make_description();
     std::ofstream of(location);
diff --git a/export/src/fmu4cpp/fmi2/fmi2_description.cpp b/export/src/fmu4cpp/fmi2/fmi2_description.cpp
@@ -8,6 +8,7 @@
 
 using namespace fmu4cpp;
 
+
 std::string fmu_base::make_description() const {
 
     const model_info m = get_model_info();
@@ -27,7 +28,7 @@ std::string fmu_base::make_description() const {
     ss << std::boolalpha
        << "\t<CoSimulation\n"
        << "\t\tneedsExecutionTool=\"" << m.needsExecutionTool << "\"\n"
-       << "\t\tmodelIdentifier=\"" << m.modelIdentifier << "\"\n"
+       << "\t\tmodelIdentifier=\"" << model_identifier() << "\"\n"
        << "\t\tcanHandleVariableCommunicationStepSize=\"" << m.canHandleVariableCommunicationStepSize << "\"\n"
        << "\t\tcanBeInstantiatedOnlyOncePerProcess=\"" << m.canBeInstantiatedOnlyOncePerProcess << "\"\n"
        << "\t\tcanGetAndSetFMUstate=\"" << m.canGetAndSetFMUstate << "\"\n"
diff --git a/export/src/fmu4cpp/fmi3/fmi3_description.cpp b/export/src/fmu4cpp/fmi3/fmi3_description.cpp
@@ -45,7 +45,7 @@ std::string fmu_base::make_description() const {
     ss << std::boolalpha
        << "\t<CoSimulation\n"
        << "\t\tneedsExecutionTool=\"" << m.needsExecutionTool << "\"\n"
-       << "\t\tmodelIdentifier=\"" << m.modelIdentifier << "\"\n"
+       << "\t\tmodelIdentifier=\"" << model_identifier() << "\"\n"
        << "\t\tcanHandleVariableCommunicationStepSize=\"" << m.canHandleVariableCommunicationStepSize << "\"\n"
        << "\t\tcanBeInstantiatedOnlyOncePerProcess=\"" << m.canBeInstantiatedOnlyOncePerProcess << "\"\n"
        << "\t\tcanGetAndSetFMUstate=\"" << m.canGetAndSetFMUstate << "\"\n"
diff --git a/export/src/fmu4cpp/fmu_base.cpp b/export/src/fmu4cpp/fmu_base.cpp
@@ -93,9 +93,9 @@ namespace fmu4cpp {
         const std::vector content{
                 info.author,
                 info.version,
-                info.modelIdentifier,
                 info.description,
-                info.modelName};
+                info.modelName,
+                model_identifier()};
 
         std::stringstream ss;
         for (const auto &str: content) {
diff --git a/export/src/fmu4cpp/model_identifier.cpp.in b/export/src/fmu4cpp/model_identifier.cpp.in
@@ -0,0 +1,7 @@
+
+
+#include "fmu4cpp/model_info.hpp"
+
+std::string fmu4cpp::model_identifier() {
+    return "@FMU4CPP_MODEL_IDENTIFIER@";
+}
diff --git a/export/src/fmu4cpp/util.hpp b/export/src/fmu4cpp/util.hpp
@@ -2,12 +2,17 @@
 #ifndef FMU4CPP_UTIL_HPP
 #define FMU4CPP_UTIL_HPP
 
+#include "hash.hpp"
+
+
 #include <functional>
 #include <string>
 #include <vector>
 
 #include "fmu4cpp/fmu_base.hpp"
 
+#include <sstream>
+
 namespace fmu4cpp {
 
     inline std::vector<const VariableBase *> collect(
diff --git a/export/tests/basic_test.cpp b/export/tests/basic_test.cpp
@@ -45,10 +45,13 @@ class Model : public fmu4cpp::fmu_base {
 
 fmu4cpp::model_info fmu4cpp::get_model_info() {
     model_info m;
-    m.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return m;
 }
 
+std::string fmu4cpp::model_identifier() {
+    return "basic";
+}
+
 FMU4CPP_INSTANTIATE(Model);
 
 
diff --git a/export/tests/fmi2/array_test.cpp b/export/tests/fmi2/array_test.cpp
@@ -40,10 +40,13 @@ fmu4cpp::model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "Array";
     info.description = "A simple model with arrays";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return info;
 }
 
+std::string fmu4cpp::model_identifier() {
+    return "array";
+}
+
 FMU4CPP_INSTANTIATE(Model);
 
 
diff --git a/export/tests/fmi2/identity_test.cpp b/export/tests/fmi2/identity_test.cpp
@@ -82,10 +82,13 @@ fmu4cpp::model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "Identity";
     info.description = "A simple feed-trough model";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return info;
 }
 
+std::string fmu4cpp::model_identifier() {
+    return "identity";
+}
+
 FMU4CPP_INSTANTIATE(Model);
 
 
diff --git a/export/tests/fmi3/array_test.cpp b/export/tests/fmi3/array_test.cpp
@@ -40,10 +40,13 @@ fmu4cpp::model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "Array";
     info.description = "A simple model with arrays";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return info;
 }
 
+std::string fmu4cpp::model_identifier() {
+    return "array";
+}
+
 FMU4CPP_INSTANTIATE(Model);
 
 
diff --git a/export/tests/fmi3/identity_test.cpp b/export/tests/fmi3/identity_test.cpp
@@ -82,10 +82,13 @@ fmu4cpp::model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "Identity";
     info.description = "A simple feed-trough model";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     return info;
 }
 
+std::string fmu4cpp::model_identifier() {
+    return "identity";
+}
+
 FMU4CPP_INSTANTIATE(Model);
 
 
diff --git a/export/tests/test_resource.cpp b/export/tests/test_resource.cpp
@@ -33,11 +33,14 @@ class Model : public fmu4cpp::fmu_base {
 };
 
 fmu4cpp::model_info fmu4cpp::get_model_info() {
-    model_info m;
-    m.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
-    return m;
+    return {};
 }
 
+std::string fmu4cpp::model_identifier() {
+    return "resource";
+}
+
+
 FMU4CPP_INSTANTIATE(Model);
 
 
diff --git a/src/model.cpp b/src/model.cpp
@@ -82,7 +82,6 @@ model_info fmu4cpp::get_model_info() {
     model_info info;
     info.modelName = "Identity";
     info.description = "A simple feed-trough model";
-    info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
     info.defaultExperiment = {0.0, 10};
 
     return info;

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ int main(int argc, char **argv) {`
`68`	`68`	`const auto handle = load_library(libName);`
`69`	`69`
`70`	`70`	`if (!handle) {`
`71`		`- const auto err = "Unable to load dynamic library '" + libName + "'! " + getLastError();`
	`71`	`+ const auto err = "[fmu4cpp modelDescription generator] Unable to load dynamic library '" + libName + "'! " + getLastError();`
`72`	`72`	`std::cerr << err << std::endl;`
`73`	`73`	`return 1;`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,6 @@ model_info fmu4cpp::get_model_info() {`
`80`	`80`	`model_info info;`
`81`	`81`	`info.modelName = "BouncingBall";`
`82`	`82`	`info.description = "A bouncing ball model";`
`83`		`- info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;`
`84`	`83`	`return info;`
`85`	`84`	`}`
`86`	`85`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,6 @@ model_info fmu4cpp::get_model_info() {`
`43`	`43`	`model_info info;`
`44`	`44`	`info.modelName = "Resource";`
`45`	`45`	`info.description = "A model with resources";`
`46`		`- info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;`
`47`	`46`	`return info;`
`48`	`47`	`}`
`49`	`48`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,6 @@ model_info fmu4cpp::get_model_info() {`
`63`	`63`	`model_info info;`
`64`	`64`	`info.modelName = "SimplePendulum";`
`65`	`65`	`info.description = "A simple pendulum model";`
`66`		`- info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;`
`67`	`66`	`info.vendorAnnotations = {"<Tool name=\"fmu4cpp\">\n\t<documentation>\"Example of tool specific annotation data\"</documentation>\n</Tool>"};`
`68`	`67`	`return info;`
`69`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,7 @@ const char *fmi2GetVersion(void) {`
`76`	`76`	`return "2.0";`
`77`	`77`	`}`
`78`	`78`
`79`		`-FMI2_Export void write_description(const char *location) {`
	`79`	`+FMI2_Export void write_description(const char location, const char modelIdentifier) {`
`80`	`80`	`const auto instance = fmu4cpp::createInstance({});`
`81`	`81`	`const auto xml = instance->make_description();`
`82`	`82`	`std::ofstream of(location);`