added default experiment and xml formatting

Author: markaren

export/examples/VanDerPol/van_der_pol.cpp

@@ -81,6 +81,7 @@ model_info fmu4cpp::get_model_info() {
     info.modelName = "VanDerPol";
     info.description = "VanDerPol oscillator";
     info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
+    info.defaultExperiment = {0.0, 20};
     return info;
 }
 

export/include/fmu4cpp/model_info.hpp

@@ -6,6 +6,13 @@
 
 namespace fmu4cpp {
 
+    struct default_experiment final {
+        double startTime{0.0};
+        std::optional<double> stopTime;
+        std::optional<double> stepSize;
+        std::optional<double> tolerance;
+    };
+
     struct model_info final {
         std::string modelName;
         std::string author;
@@ -19,6 +26,8 @@ namespace fmu4cpp {
         bool canBeInstantiatedOnlyOncePerProcess{false};
         bool canGetAndSetFMUstate{false};
         bool canSerializeFMUstate{false};
+
+        std::optional<default_experiment> defaultExperiment;
     };
 
 }// namespace fmu4cpp

export/src/fmu4cpp/fmi2/fmi2_description.cpp

@@ -12,38 +12,48 @@ std::string fmu_base::make_description() const {
 
     const model_info m = get_model_info();
     std::stringstream ss;
-    ss << R"(<?xml version="1.0" encoding="UTF-8"?>)"
-       << "\n"
-       << R"(<fmiModelDescription fmiVersion="2.0")"
-       << " modelName=\"" << m.modelName << "\""
-       << " guid=\"" << guid() << "\""
-       << " generationTool=\"fmu4cpp"
-       << " v" << to_string(library_version()) << "\""
-       << " generationDateAndTime=\"" << now() << "\""
-       << " description=\"" << m.description << "\""
-       << " author=\"" << m.author << "\""
-       << " variableNamingConvention=\"" << m.variableNamingConvention << "\""
-       << ">\n";
-
-    ss << "\t" << std::boolalpha
-       << "<CoSimulation needsExecutionTool=\"" << m.needsExecutionTool << "\""
-       << " modelIdentifier=\"" << m.modelIdentifier << "\""
-       << " canHandleVariableCommunicationStepSize=\"" << m.canHandleVariableCommunicationStepSize << "\""
-       << " canBeInstantiatedOnlyOncePerProcess=\"" << m.canBeInstantiatedOnlyOncePerProcess << "\""
-       << " canGetAndSetFMUstate=\"" << m.canGetAndSetFMUstate << "\""
-       << " canSerializeFMUstate=\"" << m.canSerializeFMUstate << "\""
-       << R"( canNotUseMemoryManagementFunctions="true")"
+    ss << R"(<?xml version="1.0" encoding="UTF-8"?>)" << "\n"
+       << "<fmiModelDescription\n"
+       << "\tfmiVersion=\"2.0\"\n"
+       << "\tmodelName=\"" << m.modelName << "\"\n"
+       << "\tguid=\"" << guid() << "\"\n"
+       << "\tgenerationTool=\"fmu4cpp v" << to_string(library_version()) << "\"\n"
+       << "\tgenerationDateAndTime=\"" << now() << "\"\n"
+       << "\tdescription=\"" << m.description << "\"\n"
+       << "\tauthor=\"" << m.author << "\"\n"
+       << "\tvariableNamingConvention=\"" << m.variableNamingConvention << "\""
+       << ">\n\n";
+
+    ss << std::boolalpha
+       << "\t<CoSimulation\n"
+       << "\t\tneedsExecutionTool=\"" << m.needsExecutionTool << "\"\n"
+       << "\t\tmodelIdentifier=\"" << m.modelIdentifier << "\"\n"
+       << "\t\tcanHandleVariableCommunicationStepSize=\"" << m.canHandleVariableCommunicationStepSize << "\"\n"
+       << "\t\tcanBeInstantiatedOnlyOncePerProcess=\"" << m.canBeInstantiatedOnlyOncePerProcess << "\"\n"
+       << "\t\tcanGetAndSetFMUstate=\"" << m.canGetAndSetFMUstate << "\"\n"
+       << "\t\tcanSerializeFMUstate=\"" << m.canSerializeFMUstate << "\"\n"
+       << "\t\tcanNotUseMemoryManagementFunctions=\"true\""
        << ">\n"
-       << "\t</CoSimulation>"
-       << "\n";
+       << "\t</CoSimulation>\n\n";
 
     if (!m.vendorAnnotations.empty()) {
         ss << "\t<VendorAnnotations>\n";
         for (const auto &annotation: m.vendorAnnotations) {
             std::string indentedAnnotation = indent_multiline_string(annotation, 3);
             ss << indentedAnnotation << "\n";
         }
-        ss << "\t</VendorAnnotations>\n";
+        ss << "\t</VendorAnnotations>\n\n";
+    }
+
+    if (m.defaultExperiment) {
+        ss << "\t<DefaultExperiment ";
+
+        ss << "startTime=\"" << m.defaultExperiment->startTime << "\"";
+        if (m.defaultExperiment->stopTime) ss << " stopTime=\"" << *m.defaultExperiment->stopTime << "\"";
+        if (m.defaultExperiment->stepSize) ss << " stepSize=\"" << *m.defaultExperiment->stepSize << "\"";
+        if (m.defaultExperiment->tolerance) ss << " tolerance=\"" << *m.defaultExperiment->tolerance << "\"";
+
+        ss << "/>\n\n";
     }
 
     ss << "\t<ModelVariables>\n";
@@ -111,7 +121,7 @@ std::string fmu_base::make_description() const {
            << "\n";
     }
 
-    ss << "\t</ModelVariables>\n";
+    ss << "\t</ModelVariables>\n\n";
 
     ss << "\t<ModelStructure>\n";
 
@@ -157,7 +167,7 @@ std::string fmu_base::make_description() const {
         ss << "\t\t</InitialUnknowns>\n";
     }
 
-    ss << "\t</ModelStructure>\n";
+    ss << "\t</ModelStructure>\n\n";
 
     ss << "</fmiModelDescription>\n";
 

export/src/fmu4cpp/fmi3/fmi3_description.cpp

@@ -24,37 +24,37 @@ namespace {
         throw std::runtime_error("Unknown variable type");
     }
 
-}
+}// namespace
 
 
 std::string fmu_base::make_description() const {
 
     const model_info m = get_model_info();
     std::stringstream ss;
-    ss << R"(<?xml version="1.0" encoding="UTF-8"?>)"
-       << "\n"
-       << R"(<fmiModelDescription fmiVersion="3.0")"
-       << " modelName=\"" << m.modelName << "\""
-       << " instantiationToken=\"" << guid() << "\""
-       << " generationTool=\"fmu4cpp"
-       << " v" << to_string(library_version()) << "\""
-       << " generationDateAndTime=\"" << now() << "\""
-       << " description=\"" << m.description << "\""
-       << " author=\"" << m.author << "\""
-       << " variableNamingConvention=\"" << m.variableNamingConvention << "\""
-       << ">\n";
-
-    ss << "\t" << std::boolalpha
-       << "<CoSimulation needsExecutionTool=\"" << m.needsExecutionTool << "\""
-       << " modelIdentifier=\"" << m.modelIdentifier << "\""
-       << " canHandleVariableCommunicationStepSize=\"" << m.canHandleVariableCommunicationStepSize << "\""
-       << " canBeInstantiatedOnlyOncePerProcess=\"" << m.canBeInstantiatedOnlyOncePerProcess << "\""
-       << " canGetAndSetFMUstate=\"" << m.canGetAndSetFMUstate << "\""
-       << " canSerializeFMUstate=\"" << m.canSerializeFMUstate << "\""
-       << R"( canNotUseMemoryManagementFunctions="true")"
-       << ">\n"
-       << "\t</CoSimulation>"
-       << "\n";
+    ss << R"(<?xml version="1.0" encoding="UTF-8"?>)" << "\n"
+       << "<fmiModelDescription fmiVersion=\"3.0\"\n"
+       << "\tmodelName=\"" << m.modelName << "\"\n"
+       << "\tinstantiationToken=\"" << guid() << "\"\n"
+       << "\tgenerationTool=\"fmu4cpp v" << to_string(library_version()) << "\"\n"
+       << "\tgenerationDateAndTime=\"" << now() << "\"\n"
+       << "\tdescription=\"" << m.description << "\"\n"
+       << "\tauthor=\"" << m.author << "\"\n"
+       << "\tvariableNamingConvention=\"" << m.variableNamingConvention << "\""
+       << ">\n\n";
+
+    ss << std::boolalpha
+       << "\t<CoSimulation\n"
+       << "\t\tneedsExecutionTool=\"" << m.needsExecutionTool << "\"\n"
+       << "\t\tmodelIdentifier=\"" << m.modelIdentifier << "\"\n"
+       << "\t\tcanHandleVariableCommunicationStepSize=\"" << m.canHandleVariableCommunicationStepSize << "\"\n"
+       << "\t\tcanBeInstantiatedOnlyOncePerProcess=\"" << m.canBeInstantiatedOnlyOncePerProcess << "\"\n"
+       << "\t\tcanGetAndSetFMUstate=\"" << m.canGetAndSetFMUstate << "\"\n"
+       << "\t\tcanSerializeFMUstate=\"" << m.canSerializeFMUstate << "\"\n"
+       << "\t\tprovidesDirectionalDerivatives=\"false\"" << "\n"
+       << "\t\tprovidesAdjointDerivatives=\"false\"" << "\n"
+       << "\t\tprovidesPerElementDependencies=\"false\"" << "\n"
+       << "\t\tprovidesEvaluateDiscreteStates=\"false\""
+       << "/>\n\n";
 
     // if (!m.vendorAnnotations.empty()) {
     //     ss << "\t<Annotations>\n";
@@ -65,6 +65,17 @@ std::string fmu_base::make_description() const {
     //     ss << "\t</Annotations>\n";
     // }
 
+    if (m.defaultExperiment) {
+        ss << "\t<DefaultExperiment ";
+
+        ss << "startTime=\"" << m.defaultExperiment->startTime << "\"";
+        if (m.defaultExperiment->stopTime) ss << " stopTime=\"" << *m.defaultExperiment->stopTime << "\"";
+        if (m.defaultExperiment->stepSize) ss << " stepSize=\"" << *m.defaultExperiment->stepSize << "\"";
+        if (m.defaultExperiment->tolerance) ss << " tolerance=\"" << *m.defaultExperiment->tolerance << "\"";
+
+        ss << "/>\n\n";
+    }
+
     ss << "\t<ModelVariables>\n";
 
     const auto allVars = [&] {
@@ -131,7 +142,7 @@ std::string fmu_base::make_description() const {
         // }
     }
 
-    ss << "\t</ModelVariables>\n";
+    ss << "\t</ModelVariables>\n\n";
 
     ss << "\t<ModelStructure>\n";
 
@@ -173,7 +184,7 @@ std::string fmu_base::make_description() const {
         }
     }
 
-    ss << "\t</ModelStructure>\n";
+    ss << "\t</ModelStructure>\n\n";
 
     ss << "</fmiModelDescription>\n";
 

src/model.cpp

@@ -83,6 +83,8 @@ model_info fmu4cpp::get_model_info() {
     info.modelName = "Identity";
     info.description = "A simple feed-trough model";
     info.modelIdentifier = FMU4CPP_MODEL_IDENTIFIER;
+    info.defaultExperiment = {0.0, 10};
+
     return info;
 }