Documentation Center

  • Trial Software
  • Product Updates

Contents

ssSetInputPortFrameData

Specify whether a port accepts signal frames

Syntax

void ssSetInputPortFrameData(SimStruct *S,  int_T port,
  Frame_T frameData)

Arguments

S

SimStruct representing an S-Function block.

port

Index of an input port.

frameData

Type of signal accepted by port. Acceptable values are FRAME_INHERITED (either frame or unframed input), FRAME_NO (unframed input only), and FRAME_YES (framed input only).

Description

Use in mdlInitializeSizes to specify whether the port accepts frame signals. By default, input ports do not accept frame signals (FRAME_NO). If the S-function specifies FRAME_INHERITED for any of its ports, the S-function should include an mdlSetInputPortFrameData callback method. This callback method sets the frame status of ports that inherit their frame status to the value that the Simulink® engine assigns to them during frame status propagation. The engine passes the assigned status to the callback as an argument. The callback method can also use this function to assign the frame status of other ports on the block whose frame status depends on the frame status of the port that inherits its frame status.

The use of frame-based signals (frameData has a value of FRAME_YES) requires a DSP System Toolbox™ product license.

Languages

C, C++

Was this topic helpful?