Configure Block Features for MATLAB S-Functions

Implement sample times, input and output functions in S-functions

MATLAB^® S-functions allow you to configure extended block functionality through various S-function APIs.

Create and configure input/output ports.
Specify block-based and port-based sample times.
Allocate memory using DWork vectors
Pass parameters to an S-function.
Create run-time parameters

Methods

S-Function Callback Methods

`setup`	Specify the number of inputs, outputs, states, parameters, and other characteristics of the MATLAB S-function
`Outputs`	Compute the signals that this MATLAB S-function block emits
`Terminate`	Perform any actions required at termination of the simulation
`CheckParameters`	Check the validity of a MATLAB S-Function's parameters
`Derivatives`	Compute a MATLAB S-Function's derivatives
`Disable`	Respond to disabling of an enabled system containing this MATLAB S-Function block
`Enable`	Respond to enabling of an enabled system containing this MATLAB S-Function block
`GetOperatingPoint`	Return operating point for MATLAB S-function as MATLAB data structure
`InitializeConditions`	Initialize the state vectors of this MATLAB S-function
`PostPropagationSetup`	Specify the sizes of the work vectors and create the run-time parameters required by this MATLAB S-function
`ProcessParameters`	Process the MATLAB S-function's parameters
`Projection`	Perturb the solver's solution of a system's states to better satisfy time-invariant solution relationships
`SetAllowConstantSampleTime`	Specify sample time behavior and tunability for S-function blocks with port-based sample times
`SetInputPortComplexSignal`	Set the numeric types (real, complex, or inherited) of the signals accepted by an input port
`SetInputPortDataType`	Set the data types of the signals accepted by an input port
`SetInputPortDimensions`	Set the dimensions of the signals accepted by an input port
`SetInputPortDimensionsMode`	Propagate the dimensions mode
`SetInputPortSampleTime`	Set the sample time of an input port that inherits its sample time from the port to which it is connected
`SetOutputPortComplexSignal`	Set the numeric types (real, complex, or inherited) of the signals accepted by an output port
`SetOutputPortDataType`	Set the data type of the signals emitted by an output port
`SetOutputPortDimensions`	Set the dimensions of the signals accepted by an output port
`SetOutputPortSampleTime`	Set the sample time of an output port that inherits its sample time from the port to which it is connected
`SetOperatingPoint`	Restore operating point of MATLAB S-function
`SimStatusChange`	Respond to a pause or resumption of the simulation of the model that contains this MATLAB S-function
`Start`	Initialize the state vectors of this MATLAB S-function
`Update`	Update a block's states
`WriteRTW`	Generate code generation data for the MATLAB S-function

Classes

`Simulink.BlockPreCompInputPortData`	Provide precompilation information about block input port
`Simulink.BlockPreCompOutputPortData`	Provide precompilation information about block output port
`Simulink.MSFcnRunTimeBlock`	Get run-time information about Level-2 MATLAB S-function block
`Simulink.RunTimeBlock`	Allow Level-2 MATLAB S-function and other MATLAB programs to get information about block while simulation is running
`Simulink.BlockData`	Provide runtime information about block-related data, such as block parameters
`Simulink.BlockPortData`	Describe block input or output port
`Simulink.BlockCompDworkData`	Provide post-compilation information about block `DWork` vector
`Simulink.BlockCompInputPortData`	Provide post-compilation information about block input port
`Simulink.BlockCompOutputPortData`	Provide post-compilation information about block output port

Topics

Create Input and Output Ports
Create input and output ports on a MATLAB S-function block.
Specify S-Function Sample Times
How to specify the rate or rates at which your block operates in MATLAB S-functions.
Use DWork Vectors in S-Functions
Use DWork vectors to allocate block data to memory.
Inherit Custom Data Types
Inherit custom data types for the values of a block's signals and parameters in MATLAB S-functions.
Pass Dialog Parameters to S-Functions
Process parameters passed via the MATLAB S-function block dialog box.
Create and Update S-Function Run-Time Parameters
Create and use run-time parameters in MATLAB S-functions.
Use MATLAB S-Functions as Sim Viewing Devices in External Mode
Specify MATLAB S-function as a sim viewing device for use in external mode.
Level-2 MATLAB S-Function Compliance with Model Operating Point
Use model operating point in MATLAB S-functions to save and restore simulation state.