The functions to create, configure and destroy the C model and associated data structures are listed in the following table.
| Name | Return | Arguments | Description |
|---|---|---|---|
| xip_cmpy_v6_0_create |
Pointer to structure holding configuration of C model object |
Pointer to structure holding configuration |
Creates new C model object and returns pointer to config structure (which is pointer to C model itself). |
| xip_cmpy_v6_0_destroy | xip_cmpy_v6_0_status |
Pointer to xip_cmpy_v6_0 (C model itself) |
Deallocates memory owned by C model and destroys C model itself. |
| xip_cmpy_v6_0_get_config | xip_cmpy_v6_0_status | Pointer to C model, pointer to configuration structure | Copies the contents of the configuration of the C model indicated to the designated configuration structure. |
| xip_array_#TYPE#_create 1 |
Pointer to created data structure |
None | Allocates memory for the structure itself, not the array members within it. |
| xip_array_#TYPE#_reserve_data 1 | xip_status | Pointer to data structure, maximum number of elements in data array. | (Re)allocates enough memory for the maximum size. Error is returned if the data_capacity of the structure is greater than space allocated. |
| xip_array_#TYPE#_reserve_dim 1 | xip_status | Pointer to data structure, maximum number of dimensions. | Allocates a small array which is to contain the size of each dimension of the data array. For example, 100 samples x 4 channels x 3 fields. |
| xip_array_#TYPE#_destroy 1 | xip_status | Pointer to data structure. | Frees up the memory allocated for the data array, the dimension array, and the data structure itself. |
|
|||