Set Data Handler - 7.2 English

FIR Compiler (PG149)

Document ID
PG149
Release Date
2022-10-26
Version
7.2 English

xip_status

xip_fir_v7_2_set_data_handler(

xip_fir_v7_2* model,

xip_array_real_handler data_handler,

void* handle,

void* opt_arg

);

This function registers a data handler call back function that is called when the output data array is filled following a call to xip_fir_v7_2_data_send . The FIR Compiler C model API contains a function, xip_fir_v7_2_data_send_handler (see Send DATA Packet ), to send data to an instance of the model whose signature matches that of a data handler.

The intention of this facility is to enable multiple instances of the model to be chained together such that only the first and last instance of the chain need to be directly controlled using the xip_fir_v7_2_data_send and xip_fir_v7_2_data_get functions.

The model only supports data handlers for output data arrays of type xip_array_real and the value passed to the ( *xip_array_real_handler ) function for the data argument is the value set by the xip_fir_v7_2_set_data_sink function. See Type Definitions for details of the data handler function signature. Its arguments are:

1. data : A pointer to the xip_array_real type containing the data to be processed. The array registered by the xip_fir_v7_2_set_data_sink function.

2. handle : A void pointer used to point to the next model instance in the filter chain.

3. opt_arg : An extra generic argument not currently used by the FIR Compiler C model.