Create System Objects

Write a MATLAB^® class that creates and defines a new System object™

You can define your own System object by customizing the implementation methods. Use graphical tools to explore the comprehensive API for creating System objects. For example, you can insert methods to initialize, run, reset, and terminate System objects. For an introduction to defining a System object, see Define Basic System Objects.

Methods

expand all

Initialize, Run, Reset

`setupImpl`	Initialize System object
`stepImpl`	System output and state update equations
`resetImpl`	Reset System object states
`releaseImpl`	Release resources

Properties and States

`infoImpl`	Information about System object
`isDoneImpl`	End-of-data flag
`isInactivePropertyImpl`	Status of inactive property
`isTunablePropertyDataTypeMutableImpl`	Set whether tunable properties can change data type
`isDiscreteStateSpecificationMutableImpl`	Control whether discrete states can change data type
`processTunedPropertiesImpl`	Action when tunable properties change
`setProperties`	Set property values using name-value pairs when creating System object
`validatePropertiesImpl`	Validate property values of System object
`getPropertyGroupsImpl`	Property groups for System object display

Input and Output

`getNumInputsImpl`	Number of inputs to the System object
`getNumOutputsImpl`	Number of outputs from System object
`getNumInputs`	Number of inputs required to call the System object
`getNumOutputs`	Number of outputs from calling the System object
`isInputComplexityMutableImpl`	Set whether System object input complexity can change
`isInputDataTypeMutableImpl`	Set whether System object input data type can change
`isInputSizeMutableImpl`	Set whether System object input size can change
`nargin`	Number of input arguments for System object
`nargout`	Number of output arguments for System object
`processInputSpecificationChangeImpl`	Perform actions when input size, complexity, or data type change
`validateInputsImpl`	Validate inputs to System object

Load and Save

`loadObjectImpl`	Load System object from MAT file
`saveObjectImpl`	Save System object in MAT file

Update Syntax

sysobjupdate Update custom System object to latest syntax

Classes

`matlab.System`	Base class for System objects
`matlab.system.mixin.FiniteSource`	Finite source mixin class

Topics

Getting Started Writing System Objects

Define Basic System Objects

Create a basic System object with the stepImpl method.

Property Attributes

Define Property Attributes

Specify property attributes to limit the type, visibility, and value of properties.

Input and Output

Change the Number of Inputs

This example shows how to set the number of inputs for a System object™ with and without using getNumInputsImpl.

Define Composite System Objects

Define System objects that include other System objects as properties.

Handle Input Specification Changes

Implement methods to restrict when System object input complexity, data type, or size can change or implement a method to react when input specifications change.