FMI Library: part of JModelica.org
fmi1_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 FMI1_IMPORT_VARIABLELIST_H_
23 #define FMI1_IMPORT_VARIABLELIST_H_
24 
25  #include "fmi1_import_variable.h"
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
45 /* Allocate an empty list */
47 
52 
57 
60 
63 
66 
76 FMILIB_EXPORT fmi1_import_variable_list_t* fmi1_import_get_sublist(fmi1_import_variable_list_t* vl, unsigned int fromIndex, unsigned int toIndex);
77 
82 
90 
97 
98 
105 
112 
127 #ifdef __cplusplus
128 }
129 #endif
130 #endif
struct fmi1_import_variable_list_t fmi1_import_variable_list_t
List of variables.
FMILIB_EXPORT fmi1_import_variable_list_t * fmi1_import_clone_variable_list(fmi1_import_variable_list_t *vl)
Make a copy of the list.
FMILIB_EXPORT fmi1_import_variable_list_t * fmi1_import_get_sublist(fmi1_import_variable_list_t *vl, unsigned int fromIndex, unsigned int toIndex)
Select sub-lists.
v size
return v
struct fmi1_xml_variable_t fmi1_import_variable_t
General variable type.
#define FMILIB_EXPORT
Used to declare the public API of the library needed for dynamic linking.
fmi1_capi_t * fmu
int(* fmi1_import_variable_filter_function_ft)(fmi1_import_variable_t *vl, void *data)
Callback function typedef for the fmiFilterVariables.
Public interface to the FMI import C-library. Handling of model variables.
fmi1_import_variable_list_t * fmi1_import_alloc_variable_list(fmi1_import_t *fmu, size_t size)
FMILIB_EXPORT fmi1_import_variable_list_t * fmi1_import_join_var_list(fmi1_import_variable_list_t *a, fmi1_import_variable_list_t *b)
Create a new variable list by concatenating two lists.
FMILIB_EXPORT fmi1_import_variable_list_t * fmi1_import_prepend_to_var_list(fmi1_import_variable_list_t *vl, fmi1_import_variable_t *v)
Prepend a variable to the variable list.
struct fmi1_import_t fmi1_import_t
FMU version 1.0 object.
FMILIB_EXPORT fmi1_import_variable_list_t * fmi1_import_append_to_var_list(fmi1_import_variable_list_t *vl, fmi1_import_variable_t *v)
Append a variable to the variable list.
FMILIB_EXPORT size_t fmi1_import_get_variable_list_size(fmi1_import_variable_list_t *vl)
Get number of variables in a list.
FMILIB_EXPORT fmi1_import_variable_list_t * fmi1_import_filter_variables(fmi1_import_variable_list_t *vl, fmi1_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...
FMILIB_EXPORT fmi1_import_variable_t * fmi1_import_get_variable(fmi1_import_variable_list_t *vl, unsigned int index)
Get a single variable from the list.
FMILIB_EXPORT jm_status_enu_t fmi1_import_var_list_push_back(fmi1_import_variable_list_t *vl, fmi1_import_variable_t *v)
Add a variable to a variable list.
jm_status_enu_t
Return status codes.
Definition: jm_types.h:44
FMILIB_EXPORT const fmi1_value_reference_t * fmi1_import_get_value_referece_list(fmi1_import_variable_list_t *vl)
Get a pointer to the list of the value references for all the variables.
FMILIB_EXPORT void fmi1_import_free_variable_list(fmi1_import_variable_list_t *vl)
Free a variable list. Note that variable lists are allocated dynamically and must be freed when not n...