Writing S-Functions Previous page   Next Page
mdlSetInputPortFrameData

Specify whether an input port accepts frame data.

C Syntax

C Arguments

S
   SimStruct representing an S-Function block.

port
   Index of a port.

frameData
   Frame data.

M Syntax

M Arguments

s
   Instance of Simulink.MSFcnRunTimeBlock class representing the S-Function block.

port
   Integer value specifying the index of port whose sampling mode is to be set.

mode
   Integer value specifying the sampling mode of the port (0 = sample, 1 = frame).

Description

This method is called with the candidate frame setting (FRAME_YES or FRAME_NO) for an input port. If the proposed setting is acceptable, the method should go ahead and set the actual frame data setting using ssSetInputPortFrameData. If the setting is unacceptable, an error should be generated via ssSetErrorStatus. Note that any other dynamic frame input or output ports whose frame data settings are implicitly defined by virtue of knowing the frame data setting of the given port can also have their frame data settings set via calls to ssSetInputPortFrameData and ssSetOutputPortFrameData.

The use of frame-based signals (mode has a value of 1) requires a Signal Processing Blockset license.

Languages

C, C++, M

See Also

ssSetInputPortFrameData, ssSetOutputPortFrameData, ssSetErrorStatus


Previous page  mdlSetInputPortDimensionInfo mdlSetInputPortSampleTime Next page

© 1994-2005 The MathWorks, Inc.