getDiscreteStateSpecificationImpl

Class: matlab.system.mixin.Propagates
Package: matlab.system.mixin

Discrete state size, data type, and complexity

Syntax

[sz,dt,cp] = getDiscreteStateSpecificationImpl(obj,name)

Description

[sz,dt,cp] = getDiscreteStateSpecificationImpl(obj,name) returns the size, data type, and complexity of the property, name. This property must be a discrete state property. You must define this method if your System object™ has discrete state properties and is used in the MATLAB System block. If you define this method for a property that is not discrete state, an error occurs during model compilation.

You always set the getDiscreteStateSpecificationImpl method access to protected because it is an internal method that users do not directly call or run.

getDiscreteStateSpecificationImpl is called by the MATLAB System block during Simulink® model compilation.

    Note:   You must set Access = protected for this method.

    You cannot modify any properties in this method.

Input Arguments

obj

System object handle

name

Name of discrete state property of the System object

Output Arguments

sz

Vector containing the length of each dimension of the property.

Default: [1 1]

dt

Data type of the property. For built-in data types, dt is a string. For fixed-point data types, dt is a numerictype object.

Default: double

cp

Complexity of the property as a scalar, logical value, where true = complex and false = real.

Default: false

Examples

expand all

Specify Discrete State Property Size, Data Type, and Complexity

Specify in your class definition file the size, data type, and complexity of a discrete state property.

methods (Access = protected)
   function [sz,dt,cp] = getDiscreteStateSpecificationImpl(~,name)
      sz = [1 1];
      dt = 'double';
      cp = false;
   end
end
Was this topic helpful?