SinkProperties

Overview

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

Discussion

The sink module copies the floating point 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 to a host processor.

The module supports floating-point values and handles both real and complex data. 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 the user gives Ymax less than Ymin then the range [Ymax Ymin] will be automatically set by MATLAB.

Additionally, this module makes the wire information available as internal variables. Block size, channel number, sample rate and signal complexity can be accessed in MATLAB code, source code, or in a layout using the ParamGet module.

Type Definition

CODE

typedef struct _ModuleSinkProperties
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 BlockSize;                              // Block Size
    INT32 NumChannels;                            // Number of Channels
    FLOAT32 SampleRate;                           // Sample Rate
    INT32 IsComplex;                              // Is Complex
    INT32 enable;                                 // To enable or disable the plotting.
    FLOAT32* value;                               // Captured values.
    FLOAT32* yRange;                              // Y-axis range.
} ModuleSinkPropertiesClass;

Variables

Properties

Name	Type	Usage	isHidden	Default value	Range	Units
BlockSize	int	const	0	32	Unrestricted
NumChannels	int	const	0	1	Unrestricted
SampleRate	float	const	0	48000	Unrestricted
IsComplex	int	const	0	0	Unrestricted
enable	int	parameter	1	0	Unrestricted
value	float*	state	0	[32 x 1]	Unrestricted
yRange	float*	parameter	0	[1 x 2]	Unrestricted

Pins

Input Pins

Name: in

Description: audio input

Data type: float

Channel range: Unrestricted

Block size range: Unrestricted

Sample rate range: Unrestricted

Complex support: Real and Complex

MATLAB Usage

File Name: sink_properties_module.m

CODE

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