FMI Library: part of JModelica.org
fmi2_import_variable_list.h
Go to the documentation of this file.
1 /*
2  Copyright (C) 2012 Modelon AB
3 
4  This program is free software: you can redistribute it and/or modify
5  it under the terms of the BSD style license.
6 
7  This program is distributed in the hope that it will be useful,
8  but WITHOUT ANY WARRANTY; without even the implied warranty of
9  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10  FMILIB_License.txt file for more details.
11 
12  You should have received a copy of the FMILIB_License.txt file
13  along with this program. If not, contact Modelon AB <http://www.modelon.com>.
14 */
15 
16 
17 
22 #ifndef FMI2_IMPORT_VARIABLELIST_H_
23 #define FMI2_IMPORT_VARIABLELIST_H_
24 
25  #include "fmi2_import_variable.h"
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
46 fmi2_import_variable_list_t* fmi2_import_alloc_variable_list(fmi2_import_t* fmu, size_t size);
47 
51 FMILIB_EXPORT void fmi2_import_free_variable_list(fmi2_import_variable_list_t* vl);
52 
56 FMILIB_EXPORT fmi2_import_variable_list_t* fmi2_import_clone_variable_list(fmi2_import_variable_list_t* vl);
57 
59 FMILIB_EXPORT size_t fmi2_import_get_variable_list_size(fmi2_import_variable_list_t* vl);
60 
62 FMILIB_EXPORT const fmi2_value_reference_t* fmi2_import_get_value_referece_list(fmi2_import_variable_list_t* vl);
63 
65 FMILIB_EXPORT fmi2_import_variable_t* fmi2_import_get_variable(fmi2_import_variable_list_t* vl, size_t index);
66 
76 FMILIB_EXPORT fmi2_import_variable_list_t* fmi2_import_get_sublist(fmi2_import_variable_list_t* vl, size_t fromIndex, size_t toIndex);
77 
81 typedef int (*fmi2_import_variable_filter_function_ft)(fmi2_import_variable_t*vl, void * data);
82 
89 FMILIB_EXPORT fmi2_import_variable_list_t* fmi2_import_filter_variables(fmi2_import_variable_list_t* vl, fmi2_import_variable_filter_function_ft filter, void* context);
90 
96 FMILIB_EXPORT fmi2_import_variable_list_t* fmi2_import_join_var_list(fmi2_import_variable_list_t* a, fmi2_import_variable_list_t* b);
97 
98 
104 FMILIB_EXPORT fmi2_import_variable_list_t* fmi2_import_append_to_var_list(fmi2_import_variable_list_t* vl, fmi2_import_variable_t* v);
105 
111 FMILIB_EXPORT fmi2_import_variable_list_t* fmi2_import_prepend_to_var_list(fmi2_import_variable_list_t* vl, fmi2_import_variable_t* v);
112 
118 FMILIB_EXPORT jm_status_enu_t fmi2_import_var_list_push_back(fmi2_import_variable_list_t* vl, fmi2_import_variable_t* v);
127 #ifdef __cplusplus
128 }
129 #endif
130 #endif
fmi2_import_get_variable_list_size
FMILIB_EXPORT size_t fmi2_import_get_variable_list_size(fmi2_import_variable_list_t *vl)
Get number of variables in a list.
fmi2_import_filter_variables
FMILIB_EXPORT fmi2_import_variable_list_t * fmi2_import_filter_variables(fmi2_import_variable_list_t *vl, fmi2_import_variable_filter_function_ft filter, void *context)
Call the provided &#39;filter&#39; function on every variable in the list and create a new list...
fmi2_import_join_var_list
FMILIB_EXPORT fmi2_import_variable_list_t * fmi2_import_join_var_list(fmi2_import_variable_list_t *a, fmi2_import_variable_list_t *b)
Create a new variable list by concatenating two lists.
fmi2_import_alloc_variable_list
fmi2_import_variable_list_t * fmi2_import_alloc_variable_list(fmi2_import_t *fmu, size_t size)
Allocate an empty list.
fmi2_import_variable_list_t
struct fmi2_import_variable_list_t fmi2_import_variable_list_t
List of variables.
Definition: fmi2_import_variable.h:63
fmi2_import_var_list_push_back
FMILIB_EXPORT jm_status_enu_t fmi2_import_var_list_push_back(fmi2_import_variable_list_t *vl, fmi2_import_variable_t *v)
Add a variable to a variable list.
size
v size
Definition: jm_vector_template.h:62
v
return v
Definition: jm_vector_template.h:63
fmi2_import_variable.h
Public interface to the FMI import C-library. Handling of model variables.
fmi2_import_get_sublist
FMILIB_EXPORT fmi2_import_variable_list_t * fmi2_import_get_sublist(fmi2_import_variable_list_t *vl, size_t fromIndex, size_t toIndex)
Select sub-lists.
FMILIB_EXPORT
#define FMILIB_EXPORT
Used to declare the public API of the library needed for dynamic linking.
fmu
fmi1_capi_t * fmu
Definition: fmi1_capi_cs_test.c:37
fmi2_import_variable_t
struct fmi2_xml_variable_t fmi2_import_variable_t
General variable type.
Definition: fmi2_import_variable.h:51
fmi2_import_append_to_var_list
FMILIB_EXPORT fmi2_import_variable_list_t * fmi2_import_append_to_var_list(fmi2_import_variable_list_t *vl, fmi2_import_variable_t *v)
Append a variable to the variable list.
fmi2_import_free_variable_list
FMILIB_EXPORT void fmi2_import_free_variable_list(fmi2_import_variable_list_t *vl)
Free a variable list. Note that variable lists are allocated dynamically and must be freed when not n...
fmi2_import_clone_variable_list
FMILIB_EXPORT fmi2_import_variable_list_t * fmi2_import_clone_variable_list(fmi2_import_variable_list_t *vl)
Make a copy of the list.
fmi2_import_variable_filter_function_ft
int(* fmi2_import_variable_filter_function_ft)(fmi2_import_variable_t *vl, void *data)
Callback function typedef for the fmiFilterVariables.
Definition: fmi2_import_variable_list.h:81
fmi2_import_prepend_to_var_list
FMILIB_EXPORT fmi2_import_variable_list_t * fmi2_import_prepend_to_var_list(fmi2_import_variable_list_t *vl, fmi2_import_variable_t *v)
Prepend a variable to the variable list.
fmi2_import_get_value_referece_list
FMILIB_EXPORT const fmi2_value_reference_t * fmi2_import_get_value_referece_list(fmi2_import_variable_list_t *vl)
Get a pointer to the list of the value references for all the variables.
fmi2_import_get_variable
FMILIB_EXPORT fmi2_import_variable_t * fmi2_import_get_variable(fmi2_import_variable_list_t *vl, size_t index)
Get a single variable from the list.
jm_status_enu_t
jm_status_enu_t
Return status codes.
Definition: jm_types.h:44
fmi2_import_t
struct fmi2_import_t fmi2_import_t
FMU version 2.0 object.
Definition: fmi_import_context.h:110
Generated by   doxygen 1.8.11