matlab.system.display.SectionGroup 类

命名空间: matlab.system.display

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

全页展开

描述

使用 getPropertyGroupsImpl 方法内的 matlab.system.display.SectionGroup 类对您为 MATLAB System (Simulink) 模块的“模块参数”对话框创建的自定义元素进行分组。节组可以包含使用 matlab.system.display.Section 类创建的节、System object™ 属性的组以及使用 matlab.system.display.Action 类创建的自定义按钮。

通过将节组与节结合使用，可以在对话框中创建嵌套的属性组。例如，节组可以实现“模块参数”对话框中的选项卡，而一个或多个节可以在该选项卡中创建可折叠面板。

类属性

Sealed
true

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

创建对象

描述

sectGrp = matlab.system.display.SectionGroup(Name,Value) 通过使用一个或多个名称-值参量定义的属性来创建节组。

示例

sectGrp = matlab.system.display.SectionGroup(sysObj) 使用基于 System object sysObj 定义的属性来创建节组。

sectGrp = matlab.system.display.SectionGroup(sysObj,Name,Value) 使用基于 System object sysObj 和一个或多个名称-值参量定义的属性来创建节组。使用名称-值参量指定的值会覆盖基于 System object 设置的值。

输入参量

全部展开

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

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

  • Title - System object 名称

  • PropertyList - System object 的所有公共属性

    您可以将此参量指定为 mfilename("class")。

属性

全部展开

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

示例: "My Property Group"

属性：

GetAccess
public
SetAccess
public

数据类型: string | char

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

  • 'Property' - 节标题来自属性组的 Title 属性。

  • 'Auto' - 节标题来自指定为构造函数的输入参量的 System object。

属性：

GetAccess
public
SetAccess
public

数据类型: string | char

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

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

示例: "My section group description."

属性：

GetAccess
public
SetAccess
public

数据类型: string | char

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

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

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

  • 隐藏属性

  • 抽象属性

  • 私有属性

  • 具有受保护访问权限的属性

  • 离散状态

  • 连续状态

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

示例: {'Property1' 'Property2'}

属性：

GetAccess
public
SetAccess
public

数据类型: cell

节组中包含的节，指定为 matlab.system.display.Section 类的一个或多个实例。

属性：

GetAccess
public
SetAccess
public

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

节组的节类型，指定为 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

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

属性：

GetAccess
public
SetAccess
public

数据类型: logical

示例

全部折叠

在 System object 的类定义文件中，使用 getPropertyGroupsImpl 方法在 MATLAB System 模块的“模块参数”对话框中定义两个选项卡。每个选项卡用于设置不同的属性值。

classdef MultipleGroupsWithSectionGroup < matlab.System

    properties
        StartValue = 0
        EndValue = 10
        Threshold = 1
        BlockLimit = 55
    end

    properties(Nontunable)
        IC1 = 0
        IC2 = 10
        IC3 = 100
        UseThreshold (1,1) logical = true
    end
    
    methods (Static, Access = protected)
        function groups = getPropertyGroupsImpl
            alwaysSection = matlab.system.display.Section(...
                'Title','','PropertyList',{'BlockLimit'});
           
            initTab = matlab.system.display.SectionGroup(...
                'Title','Initial conditions', ...
                'PropertyList',{'IC1','IC2','IC3'},...
                'GroupType', matlab.system.display.SectionType.group);
            
            valueSection = matlab.system.display.Section(...
                'Title','Value parameters',...
                'PropertyList',{'StartValue','EndValue'},...
                'SectionType',...
                matlab.system.display.SectionType.collapsiblepanel);
            
            thresholdSection = matlab.system.display.Section(...
                'Title','Threshold parameters',...
                'PropertyList',{'Threshold','UseThreshold'},...
                'SectionType',...
                matlab.system.display.SectionType.collapsiblepanel);
            
            mainTab = matlab.system.display.SectionGroup(...
                'Title','Main', ...
                'Sections',[valueSection thresholdSection],...
                'GroupType',matlab.system.display.SectionType.group);
            
            groups = [alwaysSection mainTab initTab];
        end
    end
end

将对象添加到 MATLAB System (Simulink) 模块时，该模块的“模块参数”对话框包括：

  • 头部，位于顶部

  • 范围参数的节

  • 包含用于值和阈值参数的可折叠面板的主节组

  • 位于底部的初始条件节

.

The Block Parameters dialog box for the MATLAB System block for the System object that contains the example code has the Value parameters collapsible panel expanded and the Threshold parameters collapsible panel collapsed. The Value parameters section includes text fields to set the Start Value and End Value parameters.

The Block Parameters dialog box for the MATLAB System block for the System object that contains the example code has the Value parameters panel collapsed and the Threshold parameters panel expanded. The Threshold parameters section includes a text field to set the Threshold parameter and a check box to set the Use threshold parameter.

版本历史记录

在 R2013b 中推出

另请参阅

| |

主题