Writing S-Functions

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. If the S-function specifies FRAME_INHERITED for any of its ports, the S-function should include a mdlSetInputPortFrameData callback method. The callback method should use this function to set the frame status of ports that inherit their frame status to the status that Simulink assigns to them, using its frame status propagation rules. Simulink 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 Signal Processing Blockset license.

Languages

C

See Also

ssGetInputPortFrameData, mdlSetInputPortFrameData

ssSetInputPortDirectFeedThrough

ssSetInputPortMatrixDimensions

© 1994-2005 The MathWorks, Inc.