Customize System Objects for Simulink

Customize System object™ for use in MATLAB System block

The MATLAB System block enables a System object defined in MATLAB^® to be used as a block in Simulink^®. To control the block appearance or output, or to enable System object usage in a For Each subsystem, use the provided implementation methods to customize your System object. For more information about defining a System object, see Define Basic System Objects or System Objects.

Methods

expand all

Block Appearance

`getIconImpl`	Name to display as block icon
`getHeaderImpl`	Header for System object display
`getInputNamesImpl`	Names of MATLAB System block input ports
`getOutputNamesImpl`	Names of MATLAB System block output ports
`getPropertyGroupsImpl`	Property groups for System object display
`getSimulateUsingImpl`	Specify value for Simulate using parameter
`showSimulateUsingImpl`	Visibility of Simulate using parameter
`showFiSettingsImpl`	Fixed point data type tab visibility for System objects

Input and Output

`allowModelReferenceDiscreteSampleTimeInheritanceImpl`	Model reference sample time inheritance status for discrete sample times
`getGlobalNamesImpl`	Global variable names for MATLAB System block
`getDiscreteStateImpl`	Discrete state property values
`getDiscreteStateSpecificationImpl`	Discrete state size, data type, and complexity
`getOutputDataTypeImpl`	Data types of output ports
`getOutputSizeImpl`	Sizes of output ports
`getSimulinkFunctionNamesImpl`	Register Simulink function names used in your System object
`getInterfaceImpl`	Set System object as message or data
`isOutputComplexImpl`	Complexity of output ports
`isOutputFixedSizeImpl`	Fixed- or variable-size output ports
`processTunedPropertiesImpl`	Action when tunable properties change
`propagatedInputComplexity`	Complexity of input during Simulink propagation
`propagatedInputDataType`	Data type of input during Simulink propagation
`propagatedInputFixedSize`	Fixed-size status of input during Simulink propagation
`propagatedInputSize`	Size of input during Simulink propagation

Nondirect Feedthrough

`isInputDirectFeedthroughImpl`	Direct feedthrough status of input
`outputImpl`	Output calculation from input or internal state of System object
`updateImpl`	Update object states based on inputs

Sample Time

`createSampleTime`	Create sample time specification object
`getSampleTimeImpl`	Specify sample time type, offset time, and sample time
`getSampleTime`	Query sample time
`getCurrentTime`	Current simulation time in MATLAB System block
`setNumTicksUntilNextHit`	Set the number of ticks in Simulink sample time

For Each Subsystems

supportsMultipleInstanceImpl Support System object in Simulink For Each subsystem

Classes

expand all

Block Appearance

`matlab.system.display.Icon`	Specify custom image as icon for MATLAB System block
`matlab.system.display.Action`	Create custom button in Block Parameters dialog box for MATLAB System block
`matlab.system.display.Header`	Specify header in Block Parameters dialog box for MATLAB System block
`matlab.system.display.Section`	Create property group section in Block Parameters dialog box for MATLAB System block
`matlab.system.display.SectionGroup`	Create nested groupings of properties in Block Parameters dialog box for MATLAB System block

Topics

Overview

Define System Object for Use in Simulink
Develop MATLAB System block and interactively preview block dialog box.
System Design in Simulink Using System Objects
Design systems in Simulink using System objects.
Simulink Engine Interaction with System Object Methods
Follow a process view of the order in which the MATLAB System block invokes System object methods within the context of the Simulink engine.
Considerations for Using System Objects in Simulink
Consider these guidelines when working with variable-size signals, tunable parameters, and For Each subsystems.

Block Appearance

Customize MATLAB System Icon and Dialog Box Using Mask Editor
Customize MATLAB System block appearance using Mask Editor graphical user interface.

Input and Output

Set Model Reference Discrete Sample Time Inheritance
Disallow model reference discrete sample time inheritance for a System object.
Use Global Variables in System Objects
Define global variables for use in System objects.
Specify Output
If Simulink cannot infer the System object output characteristics, add methods to specify the size, data type, complexity, or discrete state output.
Add and Implement Propagation Methods
To define output specifications, use propagation methods.

Special Use Cases

Use System Objects in Feedback Loops
Process nondirect feedthrough data through the System object.
Use Update and Output for Nondirect Feedthrough
Implement nondirect feedthrough for a System object using the updateImpl, outputImpl, and isInputDirectFeedthroughImpl methods.
Enable For Each Subsystem Support
Enable For Each subsystem support by using a System object in a Simulink For Each subsystem.
Specify Sample Time for MATLAB System Block System Objects
This example shows how to control the sample time of the MATLAB System block using System object™ methods.

Related Information

System Objects

Featured Examples

Create Moving Average Filter Block with System Object

Modify a System object to use it in Simulink.

Open Live Script

Process Message Payload Using MATLAB System Block

Send, receive, and process messages using the MATLAB System block. Use System objects to author blocks to model custom behavior to send and receive messages and manipulate the message payload.

Open Model