Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Documents: Update page title prefix

Overview

Sets scalar and array values in other modules

Discussion

The Param Set Table V2 module writes the values of one column of a statically defined table to an internal array of another module. A common use case is to update the coefficients of an FIR module based on changing conditions in the system.

...

For AWE gurus: Functionality in Param Set Table V2 can also be achieved with combining the Array Set and Table Source V2 modules for multi-dim tables or Param Set modules for scalar variables. But Param Set Table V2 adds more convenience, e.g. it supports writing into scalar values (not arrays only), Array Set by itself does not support "OnChangeSet" behavior, hence fewer number of modules in total will be required.

Type Definition

Code Block
typedef struct _ModuleParamSetTableV2
{
    ModuleInstanceDescriptor instance;            // Common Audio Weaver module instance structure
    INT32 index;                                  // Current index to table array
    INT32 setBehavior;                            // Controls the behavior of the module
    INT32 numDim;                                 // The number of dimensions of the array
    INT32 numRows;                                // The size of each vector
    INT32 numCols;                                // The number of vectors
    FLOAT32* table;                               // Array table (numDim*numRows, numCols)
    void * modPtr;                                // Points to the module to set
    void * varPtr;                                // Points to the variable to set within the module instance structure
} ModuleParamSetTableV2Class;

Variables

Properties

Name

Type

Usage

isHidden

Default value

Range

Units

index

int

parameter

0

-1

Unrestricted

setBehavior

int

parameter

0

3

Unrestricted

numDim

int

const

0

1

Unrestricted

numRows

int

const

0

2

Unrestricted

numCols

int

const

0

5

Unrestricted

table

float*

parameter

0

[2 x 5]

Unrestricted

modPtr

void *

parameter

1

Unrestricted

varPtr

void *

parameter

1

Unrestricted

Pins

Input Pins

Name: in

Description: array index

...

Sample rate range: Unrestricted

Complex support: Real

MATLAB Usage

File Name: param_set_table_v2_module.m

...