model-descriptor.hpp

#pragma once
 
/*
  Copyright 2023, SINTEF Ocean
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
 
#include <filesystem>
#include <string>
#include <vector>
 
#include <rapidxml/rapidxml.hpp>
#include <xtypes/idl/idl.hpp>
 
 
namespace ddsfmu {
namespace config {
 
void name_generator(std::string& name, const eprosima::xtypes::DynamicData::ReadableNode& rnode);
 
 
// TODO: for fmi3 this and related impl need to be extended.
enum class ScalarVariableType { Real, Integer, Boolean, String, Unknown };
 
 
std::string print_xml(const rapidxml::xml_document<>& doc);
 
void load_template_xml(
  rapidxml::xml_document<>& doc, const std::filesystem::path& template_xml,
  std::vector<char>& buffer);
 
void load_ddsfmu_mapping(
  rapidxml::xml_document<>& doc, const std::filesystem::path& ddsfmu_mapping,
  std::vector<char>& buffer);
 
void write_model_description(
  const rapidxml::xml_document<>& doc, const std::filesystem::path& fmu_root);
 
void model_variable_generator(
  rapidxml::xml_document<>& doc, rapidxml::xml_node<>* model_variables_node,
  const std::string& name, const std::string& causality, const std::uint32_t& value_ref,
  const ddsfmu::config::ScalarVariableType& type);
 
void model_structure_outputs_generator(
  rapidxml::xml_document<>& doc, rapidxml::xml_node<>* root, const std::uint32_t& num_outputs);
 
}
}