matlab.system.display.Header 类

命名空间: matlab.system.display

在 MATLAB System 模块的“模块参数”对话框中指定头部

描述

使用 matlab.system.display.Header 类指定 MATLAB System (Simulink) 模块的“模块参数”对话框中的头部内容。头部包括标题和描述性文本。还可以包含链接，指向为模块定义 System object™ 的代码。

在该模块的 getHeaderImpl 方法中创建此类的实例。

类属性

Sealed true

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

创建对象

描述

h = matlab.system.display.Header 创建 Header 类的实例。

h = matlab.system.display.Header(Name,Value) 使用一个或多个名称-值参量定义的属性值来创建 Header 类的实例。

h = matlab.system.display.Header(sysObj) 创建 Header 类的实例，并基于 System object sysObj 配置属性。

示例

h = matlab.system.display.Header(sysObj,Name,Value) 创建 Header 类的实例，并基于 System object sysObj 和一个或多个名称-值参量配置属性。您指定的名称-值参量将覆盖来自 System object 的属性值。

输入参量

全部展开

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

MATLAB System 模块的 System object，指定为 System object。当您指定 System object 作为 Header 类构造函数的输入时，该构造函数创建的实例将具有基于 System object 设置的属性。

Title - System object 名称
Text - System object 的帮助摘要
ShowSourceLink - true（除非 System object 代码是 P 代码，此时源代码不可用）

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

属性

全部展开

`Title` — “模块参数”对话框中头部的标题
`''` (默认) | 字符串 | 字符向量

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

示例: 'AlternativeTitle'

属性：

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

数据类型: string | char

`Text` — 在“模块参数”对话框中的标题下显示的描述性文本
`''` (默认) | 字符串 | 字符向量

在“模块参数”对话框中的标题下显示的描述性文本，指定为字符串或字符向量。默认情况下，文本是空字符向量 ('')。

示例: 'An alternative class description'

属性：

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

数据类型: string | char

`ShowSourceLink` — 用于在“模块参数”对话框中显示源代码链接的选项
`'true'` | `'false'`

用于在“模块参数”对话框中显示源代码链接的选项，指定为 'true' 或 'false'。

属性：

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

数据类型: string | char

示例

全部折叠

定义 MATLAB System 的“模块参数”对话框的头部

在您的类定义文件中定义标题。

 methods (Static, Access = protected)
    function header = getHeaderImpl
       header = matlab.system.display.Header(mfilename('class'), ...
           'Title','AlternativeTitle',...
           'Text','An alternative class description');
    end
 end

头部出现在“模块参数”对话框的参数部分的上方。此示例创建一个包含源代码链接的头部。

The Block Parameters dialog box for a MATLAB System block has a header with the title AlternativeTitle, the text "An alternative class description," and a link to the source code.