Sink Fract 16

Overview

Copies the data at the input pin and stores it in an internal buffer

Discussion

This module copies the data at the input pin to an internal buffer (value). The copy operation occurs at each block process and thus the data continuously updates. This module is used to store the value of a wire and make it available to the control code, or a host processor. The inspector window shows the data using a plot. In the inspector window, there are two edit boxes for maximum(Ymax) and minimum(Ymin) limits for plotting amplitude. If user gives Ymax less than Ymin then the range [Ymax Ymin] will be automatically set by MATLAB

Module Pack

Standard

ClassID

classID = 253

Type Definition

typedef struct _ModuleSinkFract16
{
ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
INT32 enable;                                 // To Enable or disable the plotting
fract16* value;                               // Captured values
FLOAT32* yRange;                              // Yaxis Range
} ModuleSinkFract16Class;

Variables

Properties

Name	Type	Usage	Default Value	Range
enable	int	parameter	0	Unrestricted
value	fract16*	state	[32 x 1]	Unrestricted
yRange	float*	parameter	[1 x 2]	Unrestricted

Pins

Input Pins


Name	in
Description	audio input
Data type	fract16
Channel range	Unrestricted
Block size range	Unrestricted
Sample rate range	Unrestricted
Complex support	Real and Complex

Matlab Usage

File Name: sink_fract16_module.m 
 M=sink_fract16_module(NAME) 
 Creates a sink (capture) module for use with the Audio Weaver 
 environment.  The module captures a block of fract16 input data and 
 stores it into an internal buffer.  Arguments: 
    NAME - name of the module.