Simulink.sdi.getSignalInputProcessingMode

Get setting of Input Processing signal property

Syntax

inputMode = Simulink.sdi.getSignalInputProcessingMode(blkPath,port)

inputMode = Simulink.sdi.getSignalInputProcessingMode(h)

Description

inputMode = Simulink.sdi.getSignalInputProcessingMode(blkPath,port) returns the setting for the Input Processing property for the signal at the specified block and port.

The Input Processing setting affects the format of the logged data and how the Simulation Data Inspector and dashboard blocks display the signal. You can configure a signal for frame-based or sample-based input processing.

inputMode = Simulink.sdi.getSignalInputProcessingMode(h) returns the setting for the Input Processing property for the signal corresponding to the specified line handle, h.

Examples

Check Signal Input Processing Setting Using Block Path

Check the setting for the Input Processing property of a signal using the block path and output port number for the block that produces the signal.

open_system('vdp')
MuInputProc = Simulink.sdi.getSignalInputProcessingMode('vdp/Mu');

Check Signal Input Processing Setting Using Line Handle

Check the setting for the Input Processing property of a signal using the line handle for the signal.

open_system('vdp')
MuLineHandles = get_param('vdp/Mu','LineHandles');
MuOutputHandle = MuLineHandles.Outport;
MuInputProc = Simulink.sdi.getSignalInputProcessingMode(MuOutputHandle);

Input Arguments

blkPath — Block path for block that produces signal

string | character array

Block path for the block that produces the signal, specified as a string or character array.

Example: "vdp/Mu"

port — Number of block output port connected to signal

scalar

Block output port number for the port that produces the signal.

Example: 1

h — Signal line handle

handle

Line handle for the signal, specified as a handle to the signal line. You can get the line handle for a signal using the get_param function with the 'LineHandles' option. For example, to access the line handle for the output of the Mu block in the model vdp, use:

MuLineHandles = get_param('vdp/Mu','LineHandles');
MuOutputLineHandle = MuLineHandles.Outport;

Example: MuOutputLineHandle

Output Arguments

inputMode — Input processing setting of the signal

"sample" | "frame"

Signal Input Processing setting.

• sample — Sample-based input processing, where each element in a sample is treated as a channel.

• frame — Frame-based input processing, where each column in a sample is treated as a channel.