--- /dev/null
+/*
+ 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 <http://www.modelon.com>.
+*/
+
+/** \file fmi2_xml_model_structure.h
+* \brief Public interface to the FMI XML C-library. Handling of vendor annotations.
+*/
+
+#ifndef FMI2_XML_MODELSTRUCTURE_H_
+#define FMI2_XML_MODELSTRUCTURE_H_
+
+#include "fmi2_xml_model_description.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+fmi2_xml_model_structure_t* fmi2_xml_allocate_model_structure(jm_callbacks* cb);
+
+void fmi2_xml_free_model_structure(fmi2_xml_model_structure_t* ms);
+
+/** \brief Get the list of all the output variables in the model.\r
+* @param ms A model structure pointer (returned by fmi2_xml_get_model_structure)\r
+* @return a variable list with all the output variables in the model.\r
+*/\r
+jm_vector(jm_voidp)* fmi2_xml_get_outputs(fmi2_xml_model_structure_t* ms);
+
+/** \brief Get the list of all the derivative variables in the model.\r
+* @param ms A model structure pointer (returned by fmi2_xml_get_model_structure)\r
+* @return a variable list with all the continuous state derivatives in the model.\r
+*/\r
+jm_vector(jm_voidp)* fmi2_xml_get_derivatives(fmi2_xml_model_structure_t* ms);
+
+/** \brief Get the list of all the discrete state variables in the model.\r
+* @param ms A model structure pointer (returned by fmi2_xml_get_model_structure)\r
+* @return a variable list with all the discrete state variables in the model.\r
+*/\r
+jm_vector(jm_voidp)* fmi2_xml_get_discrete_states(fmi2_xml_model_structure_t* ms);
+
+/** \brief Get the list of all the initial unknown variables in the model.\r
+* @param ms A model structure pointer (returned by fmi2_xml_get_model_structure)\r
+* @return a variable list with all the initial unknowns in the model.\r
+*/\r
+jm_vector(jm_voidp)* fmi2_xml_get_initial_unknowns(fmi2_xml_model_structure_t* ms);
+
+/** \brief Get dependency information in row-compressed format.
+ * @param startIndex - outputs a pointer to an array of start indices (size of array is number of outputs + 1).
+ * First element is zero, last is equal to the number of elements in the dependency and factor arrays.
+ * NULL pointer is returned if no dependency information was provided in the XML.
+ * @param dependency - outputs a pointer to the dependency index data. Indices are 1-based. Index equals to zero
+ * means "depends on all" (no information in the XML).
+ * @param factorKind - outputs a pointer to the factor kind data. The values can be converted to ::fmi2_dependency_factor_kind_enu_t
+ */
+void fmi2_xml_get_outputs_dependencies(fmi2_xml_model_structure_t* ms, size_t** startIndex, size_t** dependency, char** factorKind);
+
+/** \brief Get dependency information in row-compressed format.
+ * @param startIndex - outputs a pointer to an array of start indices (size of array is number of derivatives + 1).
+ * First element is zero, last is equal to the number of elements in the dependency and factor arrays.
+ * NULL pointer is returned if no dependency information was provided in the XML.
+ * @param dependency - outputs a pointer to the dependency index data. Indices are 1-based. Index equals to zero
+ * means "depends on all" (no information in the XML).
+ * @param factorKind - outputs a pointer to the factor kind data. The values can be converted to ::fmi2_dependency_factor_kind_enu_t
+ */
+void fmi2_xml_get_derivatives_dependencies(fmi2_xml_model_structure_t* ms, size_t** startIndex, size_t** dependency, char** factorKind);
+
+/** \brief Get dependency information in row-compressed format.
+ * @param startIndex - outputs a pointer to an array of start indices (size of array is number of discrete states + 1).
+ * First element is zero, last is equal to the number of elements in the dependency and factor arrays.
+ * NULL pointer is returned if no dependency information was provided in the XML.
+ * @param dependency - outputs a pointer to the dependency index data. Indices are 1-based. Index equals to zero
+ * means "depends on all" (no information in the XML).
+ * @param factorKind - outputs a pointer to the factor kind data. The values can be converted to ::fmi2_dependency_factor_kind_enu_t
+ */
+void fmi2_xml_get_discrete_states_dependencies(fmi2_xml_model_structure_t* ms, size_t** startIndex, size_t** dependency, char** factorKind);
+
+/** \brief Get dependency information in row-compressed format.
+ * @param startIndex - outputs a pointer to an array of start indices (size of array is number of initial unknowns + 1).
+ * First element is zero, last is equal to the number of elements in the dependency and factor arrays.
+ * NULL pointer is returned if no dependency information was provided in the XML.
+ * @param dependency - outputs a pointer to the dependency index data. Indices are 1-based. Index equals to zero
+ * means "depends on all" (no information in the XML).
+ * @param factorKind - outputs a pointer to the factor kind data. The values can be converted to ::fmi2_dependency_factor_kind_enu_t
+ */
+void fmi2_xml_get_initial_unknowns_dependencies(fmi2_xml_model_structure_t* ms, size_t** startIndex, size_t** dependency, char** factorKind);
+
+#ifdef __cplusplus
+}
+#endif
+#endif
Code Review / simantics / fmil.git / blobdiff