isTunablePropertyDataTypeMutableImpl

Class: matlab.System

Set whether tunable properties can change data type

Syntax

mutable = isTunablePropertyDataTypeMutableImpl(obj)


Description

mutable = isTunablePropertyDataTypeMutableImpl(obj) returns whether tunable properties can change data type when the object is in use.

The isTunablePropertyDataTypeMutableImpl method has no effect on the MATLAB System block. Tunable parameter datatype is always immutable in the MATLAB System block.

Method Authoring Tips

You must set Access = protected for this method.

Input Arguments

obj — System object™

System object

System object handle used to access properties, states, and methods specific to the object. If your isTunablePropertyDataTypeMutableImpl method does not use the object, you can replace this input with ~.

Output Arguments

mutable — Whether tunable property data types can change

true (default) | false

If you do not implement this method, tunable properties can change data types unless the StrictDefaults class attribute is set. If you implement this method, returning true means tunable property data types can change and false means they cannot change.

Examples

Restrict Data Type of Tunable Properties

Restrict the data type of tunable properties by adding the isTunablePropertyDataTypeMutableImpl method and returning false. By adding this method, users of the System object cannot change the data type of tunable properties while the System object is in use.

function flag = isTunablePropertyDataTypeMutableImpl(obj)
    flag = false;
end

Version History

Introduced in R2018a