Probe

Discussion

THIS MODULE IS DEPRECATED AND NOT RECOMMENDED FOR NEW DESIGNS. PLEASE USE THE TriggeredSink MODULE INSTEAD.

The probe module has an internal buffer holding 1 input or output wire's worth of data. The module continuously copies the data from the internal value buffer to the output wire, simply pass the data unchanged, or copies the data from the input wire to internal buffer.

The following table discusses the various operations types:

operationType = 0, pass the data unchanged.

operationType = 1, copy the data from input wire to internal buffer.

operationType = 2, copy the data from internal buffer to output wire.

Module Pack

Deprecated

ClassID

classID = 2033

Type Definition

typedef struct _ModuleProbe
{
ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
INT32 operationType;                          // Selects the type of operation that is implemented by the module: DATA_UNCHANGED=0, WIRE_TO_BUFFER=1, BUFFER_TO_WIRE=2
FLOAT32* value;                               // Array of interleaved audio data.
} ModuleProbeClass;

Variables

Properties

Name	Type	Usage	isHidden	Default Value	Range	Units
operationType	int	parameter	0	0	0:2
value	float*	parameter	0	[32 x 1]	Unrestricted

Pins

Input Pins


Name	in
Description	input data
Data type	{float, int, fract32}
Channel range	Unrestricted
Block size range	Unrestricted
Sample rate range	Unrestricted
Complex support	Real

Output Pins


Name	out
Description	output data
Data Type	{float, int, fract32}

Matlab Usage

File Name: probe_module.m 
 M=probe_module(NAME, DATATYPE) 
 Creates a probe module that allows you to inject test data into 
 the audio processing layout, copy the audio processed data, or simply 
 pass the data unchanged.   

 Arguments: 
    NAME - name of the module. 
    DATATYPE - string specifying the data type. This is only required 
         when generating code for this module class.