mdlSetOutputPortSampleTime

Set the sample time of an output port that inherits its sample time from the port to which it is connected

Required

Languages

C, C++

Syntax

#define MDL_SET_OUTPUT_PORT_SAMPLE_TIME
void mdlSetOutputPortSampleTime(SimStruct *S, int_T port,
 real_T sampleTime, real_T offsetTime)

Arguments

S: SimStruct representing an S-Function block.
port: Index of a port.
sampleTime: Inherited sample time for port.
offsetTime: Inherited offset time for port.

Description

The Simulink^® engine calls this method with the sample time that port inherits from the port to which it is connected.

For C MEX S-functions, if the inherited sample time is acceptable, this method should set the sample time of port to the inherited sample time and offset time, using ssSetOutputPortSampleTime and ssSetOutputPortOffsetTime. If the sample time is unacceptable, this method generates an error via ssSetErrorStatus. This method is only valid for simulation, and must be enclosed in a #if defined(MATLAB_MEX_FILE) statement.

This method can set the sample time of any other input or output port whose sample time derives from the sample time of port, using ssSetInputPortSampleTime or ssSetOutputPortSampleTime in C MEX S-functions.

Normally, sample times are propagated forward; however, if sources feeding this block have inherited sample times, the engine might choose to back-propagate known sample times to this block. When back-propagating sample times, this method is called in succession for all inherited output port signals.

See mdlSetInputPortSampleTime for more information about when this method is called.

Version History

Introduced before R2006a