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_dds_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_dds_v6_0_destroy | xip_dds_v6_0_status | Pointer to xip_dds_v6_0 (C model itself) | Deallocates memory owned by the C model and destroys the C model itself. |
| xip_dds_v6_0_get_config | xip_dds_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_create | Pointer to created data structure | None | Allocates memory for the structure itself, not the array members within it. |
| xip_array_reserve_data | xip_status | Pointer to data structure, maximum number of elements in data array | (Re)allocates enough memory for the maximum size. An error is returned if structure data_capacity is greater than the space allocated. |
| xip_array_reserve_dim | 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_destroy | xip_status | Pointer to data structure | Frees up the memory allocated for the data array, the dimension array, and the data structure itself. |
|
xip_dds_v6_0_alloc_config_pkt |
xip_dds_v6_0_status |
Pointer to xip_dds_v6_0_ config_pkt, xip_uints for number of PINC values and number of POFF values |
Allocates memory for arrays within config_pkg, but not config_pkt itself. |
|
xip_dds_v6_0_free_config_pkt |
xip_dds_v6_0_status |
Pointer to xip_dds_v6_0_config_pkt |
Deallocates memory for arrays within config pkt. |