matlab.system.display.Section 类

命名空间: matlab.system.display

在 MATLAB System 模块的“模块参数”对话框中创建属性组节

描述

使用 getPropertyGroupsImpl 方法内的 matlab.system.display.Section 类向 MATLAB System (Simulink) 模块的“模块参数”对话框添加属性组节。您可以使用该属性组对模块的 System object™ 设置属性。

类属性

Sealed true

有关类属性的信息，请参阅类属性。

创建对象

描述

示例

propGroup = matlab.system.display.Section(Name,Value) 在 MATLAB System 模块的“模块参数”对话框中创建属性组节 propGroup，并根据一个或多个名称-值参量设置该属性组的属性。

propGroup = matlab.system.display.Section(sysObj) 创建属性组节 propGroup，并根据 System object obj 设置该属性组的属性。

propGroup = matlab.system.display.Section(sysObj,Name,Value) 创建属性组节 paramGroup，并根据 System object obj 和一个或多个名称-值参量设置该属性组的属性。使用名称-值参量指定的属性会覆盖来自 System object 的属性值。

输入参量

全部展开

`sysObj` — MATLAB System 模块的 System object
System object

MATLAB System 模块的 System object，指定为 System object。

当您将 System object 指定为输入参量时，属性组的以下属性值来自 System object：

Title - System object 名称
PropertyList - System object 的所有公共属性
您可以将此参量指定为 mfilename("class")。

属性

全部展开

`Title` — 属性组标题
`''` (默认) | 字符串 | 字符向量

属性组标题，指定为字符串或字符向量。默认情况下，“模块参数”对话框中节的标题是空字符向量 ('')。

示例: "My Property Group"

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: string | char

`TitleSource` — 属性组标题的来源
`'Property'` (默认) | `'Auto'`

属性组标题的来源，指定为以下选项之一：

'Property' - 节标题来自属性组的 Title 属性。
'Auto' - 节标题来自指定为构造函数的输入参量的 System object。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: string | char

`Description` — 属性组描述
`''` (默认) | 字符串 | 字符向量

属性组描述，指定为字符串或字符向量。默认情况下，描述为空字符向量 ('')。

描述显示在“模块参数”对话框中该节中的任何属性上方。

示例: "My property group description."

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: string | char

`PropertyList` — 可在属性组内设置的属性
`{}` (默认) | 字符向量元胞数组

可在属性组内设置的属性，指定为字符向量元胞数组，其中每个字符向量定义一个属性的名称。默认情况下，属性列表是空元胞数组 ({})。

当您指定 System object 作为构造函数的输入参量时，属性列表将设置为 System object 上的所有公共属性，除非您还通过将属性列表指定为名称-值参量来覆盖该设置。

以下类型的属性不会显示在“模块参数”对话框中，也不会显示在 MATLAB^® 命令行窗口中的摘要中：

隐藏属性
抽象属性
私有属性
具有受保护访问权限的属性
离散状态
连续状态

您无法在“模块参数”对话框中显示从属属性，但这些属性会显示在 MATLAB 命令行窗口出现的 System object 摘要中。

示例: {'Property1' 'Property2'}

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: cell

`Type` — 属性组的节的类型
`matlab.system.display.SectionType`

属性组的节的类型，指定为 matlab.system.display.SectionType 枚举类的成员。

matlab.system.display.SectionType.tab - 在“模块参数”对话框中为属性组创建一个选项卡。
matlab.system.display.SectionType.panel - 在“模块参数”对话框中为属性组创建一个面板。
matlab.system.display.SectionType.group - 在“模块参数”对话框中为属性组创建一个带标题的组。
matlab.system.display.SectionType.collapsiblepanel - 在“模块参数”对话框中为属性组创建一个可折叠面板。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: matlab.system.display.SectionType

`AlignPrompts` — 用于控制容器内对齐提示的选项
`true` 或 `1` | `false` 或 `0`

用于控制容器内对齐提示的选项，指定为逻辑值 true (1) 或逻辑值 false (0)。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

示例

全部折叠

定义属性组

通过指定标题和属性列表，在您的类定义文件中定义两个属性组。

 classdef MultipleGroupsWithSection < matlab.System
    properties
        StartValue = 0
        EndValue = 10
        Threshold = 1
    end

    properties(Nontunable)
        UseThreshold (1,1) logical = true
    end
    
    methods (Static, Access = protected)
        function groups = getPropertyGroupsImpl
            valueGroup = matlab.system.display.Section(...
                "PropertyList",{'StartValue','EndValue'},...
                "SectionType", matlab.system.display.SectionType.tab);

           thresholdGroup = matlab.system.display.Section(...
                "PropertyList",{'Threshold','UseThreshold'},...
                "SectionType", matlab.system.display.SectionType.tab);
           
           group1 = matlab.system.display.SectionGroup(...,
               "Title","Value parameters",...
               'Sections',valueGroup,...
               'Type',matlab.system.display.SectionType.tab);

           group2 = matlab.system.display.SectionGroup(...,
               "Title","Threshold parameters",...
               'Sections',thresholdGroup,...
               'Type',matlab.system.display.SectionType.tab);

           groups = [group1, group2];
        end
    end
end

当您在 MATLAB System (Simulink) 模块中指定 System object 时，该模块的“模块参数”对话框有两个选项卡，分别对应于两个属性组。

The Block Parameters dialog box for the MATLAB System block has a header followed by a section with two tabs. The tab labeled Value parameters is selected and shows text fields that set the Start Value and End Value parameters for the System object.