/* Copyright (C) 2012 Modelon AB This program is free software: you can redistribute it and/or modify it under the terms of the BSD style license. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the FMILIB_License.txt file for more details. You should have received a copy of the FMILIB_License.txt file along with this program. If not, contact Modelon AB . */ #include #include #include #include #include #include #include #include "fmi2_import_impl.h" #include "fmi2_import_variable_list_impl.h" static const char* module = "FMILIB"; /*#include "fmi2_import_vendor_annotations_impl.h" #include "fmi2_import_parser.h" */ fmi2_import_t* fmi2_import_allocate(jm_callbacks* cb) { fmi2_import_t* fmu = (fmi2_import_t*)cb->calloc(1, sizeof(fmi2_import_t)); if(!fmu || (jm_vector_init(char)(&fmu->logMessageBufferCoded,JM_MAX_ERROR_MESSAGE_SIZE,cb) < JM_MAX_ERROR_MESSAGE_SIZE)) { jm_log_fatal(cb, module, "Could not allocate memory"); if(fmu) cb->free(fmu); return 0; } fmu->dirPath = 0; fmu->resourceLocation = 0; fmu->callbacks = cb; fmu->capi = 0; fmu->md = fmi2_xml_allocate_model_description(cb); jm_vector_init(char)(&fmu->logMessageBufferExpanded,0,cb); if(!fmu->md) { cb->free(fmu); return 0; } return fmu; } const char* fmi2_import_get_last_error(fmi2_import_t* fmu) { return jm_get_last_error(fmu->callbacks); } fmi2_import_t* fmi2_import_parse_xml( fmi_import_context_t* context, const char* dirPath, fmi2_xml_callbacks_t* xml_callbacks) { char* xmlPath; char absPath[FILENAME_MAX + 2]; fmi2_import_t* fmu = 0; int configuration = 0; if(strlen(dirPath) + 20 > FILENAME_MAX) { jm_log_fatal(context->callbacks, module, "Directory path for FMU is too long"); return 0; } xmlPath = fmi_import_get_model_description_path(dirPath, context->callbacks); fmu = fmi2_import_allocate(context->callbacks); if(!fmu) { context->callbacks->free(xmlPath); return 0; } if(jm_get_dir_abspath(context->callbacks, dirPath, absPath, FILENAME_MAX + 2)) { size_t len = strlen(absPath); strcpy(absPath + len, FMI_FILE_SEP "resources"); fmu->resourceLocation = fmi_import_create_URL_from_abs_path(context->callbacks, absPath); } fmu->dirPath = context->callbacks->malloc(strlen(dirPath) + 1); if (!fmu->dirPath || !fmu->resourceLocation) { jm_log_fatal( context->callbacks, "FMILIB", "Could not allocated memory"); fmi2_import_free(fmu); context->callbacks->free(xmlPath); return 0; } strcpy(fmu->dirPath, dirPath); jm_log_verbose( context->callbacks, "FMILIB", "Parsing model description XML"); /* convert the import configuration to the xml configuration */ if (context->configuration & FMI_IMPORT_NAME_CHECK) { configuration |= FMI2_XML_NAME_CHECK; } if (fmi2_xml_parse_model_description( fmu->md, xmlPath, xml_callbacks, configuration)) { fmi2_import_free(fmu); fmu = 0; } context->callbacks->free(xmlPath); if(fmu) jm_log_verbose( context->callbacks, "FMILIB", "Parsing finished successfully"); return fmu; } void fmi2_import_free(fmi2_import_t* fmu) { jm_callbacks* cb; if(!fmu) return; cb = fmu->callbacks; jm_log_verbose( fmu->callbacks, "FMILIB", "Releasing allocated library resources"); fmi2_import_destroy_dllfmu(fmu); fmi2_xml_free_model_description(fmu->md); jm_vector_free_data(char)(&fmu->logMessageBufferCoded); jm_vector_free_data(char)(&fmu->logMessageBufferExpanded); cb->free(fmu->resourceLocation); cb->free(fmu->dirPath); cb->free(fmu); } int fmi2_import_check_has_FMU(fmi2_import_t* fmu) { if(!fmu->md) { jm_log_error(fmu->callbacks, module,"No FMU is loaded"); return 0; } return 1; } const char* fmi2_import_get_model_name(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_model_name(fmu->md); } unsigned int fmi2_import_get_capability(fmi2_import_t* fmu , fmi2_capabilities_enu_t id) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_capability(fmu->md, id); } const char* fmi2_import_get_model_identifier_ME(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_model_identifier_ME(fmu->md); } const char* fmi2_import_get_model_identifier_CS(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_model_identifier_CS(fmu->md); } const char* fmi2_import_get_GUID(fmi2_import_t* fmu){ if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_GUID(fmu->md); } const char* fmi2_import_get_description(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_description(fmu->md); } const char* fmi2_import_get_author(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_author(fmu->md); } const char* fmi2_import_get_license(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_license(fmu->md); } const char* fmi2_import_get_copyright(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_copyright(fmu->md); } const char* fmi2_import_get_model_standard_version(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_model_standard_version(fmu->md); } const char* fmi2_import_get_model_version(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_model_version(fmu->md); } const char* fmi2_import_get_generation_tool(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_generation_tool(fmu->md); } const char* fmi2_import_get_generation_date_and_time(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_generation_date_and_time(fmu->md); } fmi2_variable_naming_convension_enu_t fmi2_import_get_naming_convention(fmi2_import_t* fmu) { if(!fmu->md) { jm_log_error(fmu->callbacks, module,"No FMU is loaded"); return fmi2_naming_enu_unknown; } return fmi2_xml_get_naming_convention(fmu->md); } size_t fmi2_import_get_number_of_continuous_states(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_number_of_continuous_states(fmu->md); } size_t fmi2_import_get_number_of_event_indicators(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_number_of_event_indicators(fmu->md); } double fmi2_import_get_default_experiment_start(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_default_experiment_start(fmu->md); } double fmi2_import_get_default_experiment_stop(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_default_experiment_stop(fmu->md); } double fmi2_import_get_default_experiment_tolerance(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_default_experiment_tolerance(fmu->md); } double fmi2_import_get_default_experiment_step(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_default_experiment_step(fmu->md); } fmi2_import_unit_definitions_t* fmi2_import_get_unit_definitions(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_unit_definitions(fmu->md); } unsigned int fmi2_import_get_unit_definitions_number(fmi2_import_unit_definitions_t* ud) { return fmi2_xml_get_unit_definitions_number(ud); } fmi2_import_type_definitions_t* fmi2_import_get_type_definitions(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_type_definitions(fmu->md); } fmi2_import_variable_list_t* fmi2_import_vector_to_varlist(fmi2_import_t* fmu, jm_vector(jm_voidp)* vars) { fmi2_import_variable_list_t* vl; size_t nv, i; if(!vars) return 0; nv = jm_vector_get_size(jm_voidp)(vars); vl = fmi2_import_alloc_variable_list(fmu, nv); if(!vl) return 0; for(i = 0; i< nv; i++) { jm_vector_set_item(jm_voidp)(&vl->variables, i, jm_vector_get_item(jm_voidp)(vars, i)); } return vl; } /* Get the list of all the variables in the model */ /* 0 - original order as found in the XML file; 1 - sorted alfabetically by variable name; 2 sorted by types/value references. */ fmi2_import_variable_list_t* fmi2_import_get_variable_list(fmi2_import_t* fmu, int sortOrder) { if(!fmi2_import_check_has_FMU(fmu)) return 0; switch(sortOrder) { case 0: return fmi2_import_vector_to_varlist(fmu, fmi2_xml_get_variables_original_order(fmu->md)); case 1: { fmi2_import_variable_list_t* vl; size_t nv, i; jm_vector(jm_named_ptr)* vars = fmi2_xml_get_variables_alphabetical_order(fmu->md); if(!vars) return 0; nv = jm_vector_get_size(jm_named_ptr)(vars); vl = fmi2_import_alloc_variable_list(fmu, nv); if(!vl) return 0; for(i = 0; i< nv; i++) { jm_vector_set_item(jm_voidp)(&vl->variables, i, jm_vector_get_item(jm_named_ptr)(vars, i).ptr); } return vl; } case 2: return fmi2_import_vector_to_varlist(fmu, fmi2_xml_get_variables_vr_order(fmu->md)); default: assert(0); } return 0; } fmi2_fmu_kind_enu_t fmi2_import_get_fmu_kind(fmi2_import_t* fmu) { return fmi2_xml_get_fmu_kind(fmu->md); } size_t fmi2_import_get_vendors_num(fmi2_import_t* fmu){ if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_vendors_num(fmu->md); } const char* fmi2_import_get_vendor_name(fmi2_import_t* fmu, size_t index){ if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_xml_get_vendor_name(fmu->md, index); } /** \brief Get the number of log categories defined in the XML */ size_t fmi2_import_get_log_categories_num(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_size(jm_string)(fmi2_xml_get_log_categories(fmu->md)); } /** \brief Get the log category by index */ const char* fmi2_import_get_log_category(fmi2_import_t* fmu, size_t index) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_item(jm_string)(fmi2_xml_get_log_categories(fmu->md), index); } /** \brief Get the log category description by index */ const char* fmi2_import_get_log_category_description(fmi2_import_t* fmu, size_t index) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_item(jm_string)(fmi2_xml_get_log_category_descriptions(fmu->md), index); } /** \brief Get the number of source files for ME defined in the XML */ size_t fmi2_import_get_source_files_me_num(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_size(jm_string)(fmi2_xml_get_source_files_me(fmu->md)); } /** \brief Get the ME source file by index */ const char* fmi2_import_get_source_file_me(fmi2_import_t* fmu, size_t index) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_item(jm_string)(fmi2_xml_get_source_files_me(fmu->md), index); } /** \brief Get the number of source files for CS defined in the XML */ size_t fmi2_import_get_source_files_cs_num(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_size(jm_string)(fmi2_xml_get_source_files_cs(fmu->md)); } /** \brief Get the CS source file by index */ const char* fmi2_import_get_source_file_cs(fmi2_import_t* fmu, size_t index) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return jm_vector_get_item(jm_string)(fmi2_xml_get_source_files_cs(fmu->md), index); } fmi2_import_variable_list_t* fmi2_import_get_outputs_list(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_import_vector_to_varlist(fmu, fmi2_xml_get_outputs(fmi2_xml_get_model_structure(fmu->md))); } fmi2_import_variable_list_t* fmi2_import_get_derivatives_list(fmi2_import_t* fmu){ if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_import_vector_to_varlist(fmu, fmi2_xml_get_derivatives(fmi2_xml_get_model_structure(fmu->md))); } fmi2_import_variable_list_t* fmi2_import_get_discrete_states_list(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_import_vector_to_varlist(fmu, fmi2_xml_get_discrete_states(fmi2_xml_get_model_structure(fmu->md))); } fmi2_import_variable_list_t* fmi2_import_get_initial_unknowns_list(fmi2_import_t* fmu) { if(!fmi2_import_check_has_FMU(fmu)) return 0; return fmi2_import_vector_to_varlist(fmu, fmi2_xml_get_initial_unknowns(fmi2_xml_get_model_structure(fmu->md))); } void fmi2_import_get_outputs_dependencies(fmi2_import_t* fmu,size_t** startIndex, size_t** dependency, char** factorKind) { fmi2_xml_model_structure_t* ms; if(!fmi2_import_check_has_FMU(fmu)) { *startIndex = 0; return; } ms = fmi2_xml_get_model_structure(fmu->md); assert(ms); fmi2_xml_get_outputs_dependencies(ms, startIndex, dependency, factorKind); } void fmi2_import_get_derivatives_dependencies(fmi2_import_t* fmu,size_t** startIndex, size_t** dependency, char** factorKind) { fmi2_xml_model_structure_t* ms; if(!fmi2_import_check_has_FMU(fmu)) { *startIndex = 0; return; } ms = fmi2_xml_get_model_structure(fmu->md); assert(ms); fmi2_xml_get_derivatives_dependencies(ms, startIndex, dependency, factorKind); } void fmi2_import_get_discrete_states_dependencies(fmi2_import_t* fmu,size_t** startIndex, size_t** dependency, char** factorKind) { fmi2_xml_model_structure_t* ms; if(!fmi2_import_check_has_FMU(fmu)) { *startIndex = 0; return; } ms = fmi2_xml_get_model_structure(fmu->md); assert(ms); fmi2_xml_get_discrete_states_dependencies(ms, startIndex, dependency, factorKind); } void fmi2_import_get_initial_unknowns_dependencies(fmi2_import_t* fmu,size_t** startIndex, size_t** dependency, char** factorKind) { fmi2_xml_model_structure_t* ms; if(!fmi2_import_check_has_FMU(fmu)) { *startIndex = 0; return; } ms = fmi2_xml_get_model_structure(fmu->md); assert(ms); fmi2_xml_get_initial_unknowns_dependencies(ms, startIndex, dependency, factorKind); }