Skip to content

Commit

Permalink
Rename _get_variable_initial -> _get_initial (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
filip-stenstrom authored and modelonrobinandersson committed Jul 14, 2023
1 parent 7070367 commit 3544fa9
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 16 deletions.
8 changes: 4 additions & 4 deletions Test/FMI3/fmi3_import_model_structure_test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -138,9 +138,9 @@ static void test_fmi3_import_get_clocked_states(fmi3_import_t* fmu) {
fmi3_import_free_variable_list(varList);
}

static void test_fmi3_import_get_variable_initial_unknowns(fmi3_import_t* fmu) {
static void test_fmi3_import_get_initial_unknowns(fmi3_import_t* fmu) {

fmi3_import_variable_list_t* varList = fmi3_import_get_variable_initial_unknowns_list(fmu);
fmi3_import_variable_list_t* varList = fmi3_import_get_initial_unknowns_list(fmu);
REQUIRE(fmi3_import_get_variable_list_size(varList) == 1);

/* check VRs and dependencies of all InitialUnknowns */
Expand All @@ -151,7 +151,7 @@ static void test_fmi3_import_get_variable_initial_unknowns(fmi3_import_t* fmu) {

fmi3_import_variable_t* var = fmi3_import_get_variable(varList, 0);
REQUIRE(fmi3_import_get_variable_vr(var) == 1);
REQUIRE(fmi3_import_get_variable_initial_unknown_dependencies(fmu, var, &numDependencies, &dependsOnAll, &dependencies, &dependenciesKind) == 0);
REQUIRE(fmi3_import_get_initial_unknown_dependencies(fmu, var, &numDependencies, &dependsOnAll, &dependencies, &dependenciesKind) == 0);
REQUIRE(numDependencies == 0);
REQUIRE(dependsOnAll == 1);
REQUIRE(dependencies == nullptr);
Expand Down Expand Up @@ -228,7 +228,7 @@ TEST_CASE("Valid ModelStructure parsing") {
}

SECTION("Get InitialUnknowns") {
test_fmi3_import_get_variable_initial_unknowns(fmu);
test_fmi3_import_get_initial_unknowns(fmu);
}

SECTION("Get EventIndicators") {
Expand Down
6 changes: 3 additions & 3 deletions src/Import/include/FMI3/fmi3_import.h
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ FMILIB_EXPORT fmi3_import_variable_list_t* fmi3_import_get_clocked_states_list(f
*
* Note that variable lists are allocated dynamically and must be freed when not needed any longer.
*/
FMILIB_EXPORT fmi3_import_variable_list_t* fmi3_import_get_variable_initial_unknowns_list(fmi3_import_t* fmu);
FMILIB_EXPORT fmi3_import_variable_list_t* fmi3_import_get_initial_unknowns_list(fmi3_import_t* fmu);

/** \brief Get the list of all the event indicator variables in the model.
* @param fmu An FMU object as returned by fmi3_import_parse_xml().
Expand Down Expand Up @@ -387,15 +387,15 @@ FMILIB_EXPORT int fmi3_import_get_clocked_state_dependencies(fmi3_import_t* fmu,

/** \brief Get dependency information for an InitialUnknown.
* @param fmu - An FMU object as returned by fmi3_import_parse_xml().
* @param variable - A model variable in fmi3_import_get_variable_initial_unknowns_list(...)
* @param variable - A model variable in fmi3_import_get_initial_unknowns_list(...)
* @param numDependencies - outputs number of dependencies; 0 for no dependencies and depends on all, check 'dependsOnAll' output
* @param dependsOnAll - outputs 1 if a variable depends on all variables, else 0. Only relevant if numDependencies == 0
* @param dependencies - outputs a pointer to the dependencies (valueReferences), NULL if numDependencies == 0
* @param dependenciesKind - outputs a pointer to the dependencieskind data. The values can be converted to ::fmi3_dependencies_kind_enu_t
* NULL if numDependencies == 0
* @return - non-zero if variable cannot be found (e.g., not an InitialUnknown), invalid inputs or unexpected failures
*/
FMILIB_EXPORT int fmi3_import_get_variable_initial_unknown_dependencies(fmi3_import_t* fmu, fmi3_import_variable_t* variable,
FMILIB_EXPORT int fmi3_import_get_initial_unknown_dependencies(fmi3_import_t* fmu, fmi3_import_variable_t* variable,
size_t* numDependencies, int* dependsOnAll, size_t** dependencies, char** dependenciesKind);

/** \brief Get dependency information for an EventIndicator.
Expand Down
8 changes: 4 additions & 4 deletions src/Import/src/FMI3/fmi3_import.c
Original file line number Diff line number Diff line change
Expand Up @@ -432,9 +432,9 @@ fmi3_import_variable_list_t* fmi3_import_get_clocked_states_list(fmi3_import_t*
return fmi3_import_vector_to_varlist(fmu, fmi3_xml_get_clocked_states(fmi3_xml_get_model_structure(fmu->md)));
}

fmi3_import_variable_list_t* fmi3_import_get_variable_initial_unknowns_list(fmi3_import_t* fmu) {
fmi3_import_variable_list_t* fmi3_import_get_initial_unknowns_list(fmi3_import_t* fmu) {
if (!fmi3_import_check_has_FMU(fmu)) return NULL;
return fmi3_import_vector_to_varlist(fmu, fmi3_xml_get_variable_initial_unknowns(fmi3_xml_get_model_structure(fmu->md)));
return fmi3_import_vector_to_varlist(fmu, fmi3_xml_get_initial_unknowns(fmi3_xml_get_model_structure(fmu->md)));
}

fmi3_import_variable_list_t* fmi3_import_get_event_indicators_list(fmi3_import_t* fmu) {
Expand Down Expand Up @@ -478,15 +478,15 @@ int fmi3_import_get_clocked_state_dependencies(fmi3_import_t* fmu, fmi3_import_v
numDependencies, dependsOnAll, dependencies, dependenciesKind);
}

int fmi3_import_get_variable_initial_unknown_dependencies(fmi3_import_t* fmu, fmi3_import_variable_t* variable,
int fmi3_import_get_initial_unknown_dependencies(fmi3_import_t* fmu, fmi3_import_variable_t* variable,
size_t* numDependencies, int* dependsOnAll, size_t** dependencies, char** dependenciesKind)
{
fmi3_xml_model_structure_t* ms;
if (!fmi3_import_check_has_FMU(fmu)) return -1;

ms = fmi3_xml_get_model_structure(fmu->md);
assert(ms);
return fmi3_xml_get_variable_initial_unknown_dependencies(ms, variable,
return fmi3_xml_get_initial_unknown_dependencies(ms, variable,
numDependencies, dependsOnAll, dependencies, dependenciesKind);
}

Expand Down
6 changes: 3 additions & 3 deletions src/XML/include/FMI3/fmi3_xml_model_structure.h
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ jm_vector(jm_voidp)* fmi3_xml_get_clocked_states(fmi3_xml_model_structure_t* ms)
* @param ms A model structure pointer (returned by fmi3_xml_get_model_structure)
* @return a variable list with all the initial unknowns in the model.
*/
jm_vector(jm_voidp)* fmi3_xml_get_variable_initial_unknowns(fmi3_xml_model_structure_t* ms);
jm_vector(jm_voidp)* fmi3_xml_get_initial_unknowns(fmi3_xml_model_structure_t* ms);

/** \brief Get the list of all the event indicator variables in the model.
* @param ms A model structure pointer (returned by fmi3_xml_get_model_structure)
Expand Down Expand Up @@ -101,15 +101,15 @@ int fmi3_xml_get_clocked_state_dependencies(fmi3_xml_model_structure_t* ms, fmi3

/** \brief Get dependency information for an InitialUnknown.
* @param ms - A model structure pointer (returned by fmi3_xml_get_model_structure)
* @param variable - A model variable, e.g., from fmi3_xml_get_variable_initial_unknowns() vector.
* @param variable - A model variable, e.g., from fmi3_xml_get_initial_unknowns() vector.
* @param numDependencies - outputs number of dependencies; 0 for no dependencies and depends on all, check 'dependsOnAll' output
* @param dependsOnAll - outputs 1 if a variable depends on all variables, else 0. Only relevant if numDependencies == 0
* @param dependencies - outputs a pointer to the dependencies (valueReferences), NULL if numDependencies == 0
* @param dependenciesKind - outputs a pointer to the dependencieskind data. The values can be converted to ::fmi3_dependencies_kind_enu_t
* NULL if numDependencies == 0
* @return - non-zero if variable cannot be found (e.g., not an InitialUnknown), invalid inputs or unexpected failures
*/
int fmi3_xml_get_variable_initial_unknown_dependencies(fmi3_xml_model_structure_t* ms, fmi3_xml_variable_t* variable,
int fmi3_xml_get_initial_unknown_dependencies(fmi3_xml_model_structure_t* ms, fmi3_xml_variable_t* variable,
size_t* numDependencies, int* dependsOnAll, size_t** dependencies, char** dependenciesKind);

/** \brief Get dependency information for an EventIndicator.
Expand Down
4 changes: 2 additions & 2 deletions src/XML/src/FMI3/fmi3_xml_model_structure.c
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jm_vector(jm_voidp)* fmi3_xml_get_clocked_states(fmi3_xml_model_structure_t* ms)
return &ms->clockedStates;
}

jm_vector(jm_voidp)* fmi3_xml_get_variable_initial_unknowns(fmi3_xml_model_structure_t* ms) {
jm_vector(jm_voidp)* fmi3_xml_get_initial_unknowns(fmi3_xml_model_structure_t* ms) {
return &ms->initialUnknowns;
}

Expand Down Expand Up @@ -155,7 +155,7 @@ int fmi3_xml_get_clocked_state_dependencies(fmi3_xml_model_structure_t* ms, fmi3
numDependencies, dependsOnAll, dependencies, dependenciesKind);
}

int fmi3_xml_get_variable_initial_unknown_dependencies(fmi3_xml_model_structure_t* ms, fmi3_xml_variable_t* variable,
int fmi3_xml_get_initial_unknown_dependencies(fmi3_xml_model_structure_t* ms, fmi3_xml_variable_t* variable,
size_t* numDependencies, int* dependsOnAll, size_t** dependencies, char** dependenciesKind)
{
return fmi3_xml_get_dependencies(&(ms->initialUnknowns), ms->initialUnknownDeps, variable,
Expand Down

0 comments on commit 3544fa9

Please sign in to comment.