Overview
Sets status in other modules
Discussion
This module sets the status of other modules. This module differs from the original StatusSet in its use of backlash to inidicate relative hiearchy of the module to control. The usage here is consistent with the usage in the ParamSet module. See below for more detail.
Arguments:
MOD specifies the module/subsystem to be controlled. If a subsystem is specified, then this module will recursively act on all modules and subsystem within that subsystem. The name specified is relative to the level of the status_set_module.
The specified MOD name can either be an absolute or relative path from the status_set_module. The backslash character '\' before a module is used to denote a module one level up in hierachy. Multiple backslashes can be used to represent multiple levels of hierarchy. status_set_module is 'levelA.levelB.ss'
...
If setBehavior == 0, then the other module's status will be updated in the Set() function only when the status change detected.
If setBehavior == 1, then the other module's status will be updated instantly in the Process() function only if there is a change detected.
If setBehavior == 2, then the other module's status will be updated always in the Set() function.
If setBehavior == 3, then the other module's status will be updated always in the Process() function.
Type Definition
| Code Block |
|---|
typedef struct _ModuleStatusSetV2
{
ModuleInstanceDescriptor instance; // Common Audio Weaver module instance structure
INT32 setBehavior; // Controls the behavior of setting status
INT32 prevStatus; // Previous status
INT32 nextStatus; // Status value from the input wire.
INT32 numModules; // Total number of modules this module controls
INT32* modIds; // Array to hold the object IDs of modules to set
ModuleInstanceDescriptor ** modPtr; // Points to the module to set
} ModuleStatusSetV2Class; |
Properties
Name | Type | Usage | isHidden | Default value | Range | Units |
setBehavior | int | parameter | 0 | 0 | 0:3 | |
prevStatus | int | state | 1 | -1 | Unrestricted | |
nextStatus | int | state | 1 | 0 | Unrestricted | |
numModules | int | state | 1 | 1 | Unrestricted | |
modIds | int* | state | 1 | [1 x 1] | Unrestricted | |
modPtr | ModuleInstanceDescriptor ** | state | 1 | Unrestricted |
Pins
Input Pins
Name: in
Description: status value
...
Sample rate range: Unrestricted
Complex support: Real
MATLAB Usage
File Name: status_set_v2_module.m
...