S-Function

Include S-function in model

expand all in page
  • Library:

  • Simulink / User-Defined Functions

  • S-Function block

Description

The S-Function block provides access to S-functions from a block diagram. The S-function named as the S-function name parameter can be a Level-2 MATLAB® or a Level-1 or Level-2 C MEX S-function (see MATLAB S-Function Basics for information on how to create S-functions).

Note

Use the Level-2 MATLAB S-Function block to include a Level-2 MATLAB S-function in a block diagram.

The S-Function block displays the name of the specified S-function and the number of input and output ports specified by the S-function. Signals connected to the inputs must have the dimensions specified by the S-function for the inputs.

Parameters

expand all

Use this parameter to specify the name of your S-function.

Programmatic Use

Block Parameter: FunctionName
Type: character vector
Value: name of the S-function
Default: 'system'

Specify the additional S-function parameters.

The function parameters can be specified as MATLAB expressions or as variables separated by commas. For example,

A, B, C, D, [eye(2,2);zeros(2,2)]

Note that although individual parameters can be enclosed in brackets, the list of parameters must not be enclosed in brackets.

Programmatic Use

Block Parameter: Parameters
Type: character vector
Value: S-function parameters
Default: ' '

This parameter applies only if this block represents a C MEX S-function and you intend to use the Simulink® Coder™ software to generate code from the model containing the block. If you use it, when you are ready to generate code, you must force the coder to rebuild the top model as explained in Control Regeneration of Top Model Code (Simulink Coder).

For more information on using this parameter, see Specify Additional Source Files for an S-Function (Simulink Coder).

Programmatic Use

Block Parameter: SFunctionModules
Type: character vector
Value: character vector of file names
Default: ' '

Model Examples

Inverted Pendulum with Animation

Inverted Pendulum with Animation

Model an inverted pendulum. The animation is created using MATLAB® Handle Graphics®. The animation block is a masked S-function. For more information, use the context menu to look under the Animation block's mask and open the S-function for editing.

Open Model
Custom Code and Hand Coded Blocks using the S-function API

Custom Code and Hand Coded Blocks using the S-function API

This library launches examples of different types of Simulink® S-functions. Simulink S-functions allow you to extend Simulink with new hand coded blocks, interface to custom external code, and create live interfaces to other programs. Models containing S-functions in the following programming languages can be accessed through this demonstration: C, C++, M and Fortran.

Open Model
Run Quality Checks on S-Functions

Run Quality Checks on S-Functions

Demonstrates how to use S-Function analyzer APIs to check S-functions, in order to identify potential problems and improvements.

Open Script

Block Characteristics

Data Types

Boolean[a] | bus[a] | double[a] | fixed point[b][a] | half[a] | integer[a] | single[a] | string[a]

Direct Feedthrough

limited[a]

Multidimensional Signals

limited[a]

Variable-Size Signals

limited[a]

Zero-Crossing Detection

limited[a]

[a] Actual data type or capability support depends on block implementation.

[b] See Writing Fixed-Point S-Functions for details on using fixed-point data types in S-functions.

Extended Capabilities

See Also

|

Topics

Introduced before R2006a

Simulink Documentation

Support