matlab.system.display.Header クラス

名前空間: matlab.system.display

MATLAB System ブロックの [ブロックパラメーター] ダイアログボックスでヘッダーを指定する

説明

matlab.system.display.Header クラスを使用して、MATLAB System ブロックの [ブロックパラメーター] ダイアログボックス内のヘッダーの内容を指定します。ヘッダーにはタイトルと説明テキストが含まれます。ブロックの System object™ を定義するコードへのリンクを含めることもできます。

ブロックの getHeaderImpl メソッド内にこのクラスのインスタンスを作成します。

クラス属性

Sealed true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

h = matlab.system.display.Header は Header クラスのインスタンスを作成します。

h = matlab.system.display.Header(Name,Value) は、1 つ以上の名前と値の引数を使用して定義されたプロパティ値によって Header クラスのインスタンスを作成します。

h = matlab.system.display.Header(sysObj) は Header クラスのインスタンスを作成し、System object sysObj に基づいてプロパティを構成します。

例

h = matlab.system.display.Header(sysObj,Name,Value) は Header クラスのインスタンスを作成し、System object sysObj および 1 つ以上の名前と値の引数に基づいてプロパティを構成します。指定した名前と値の引数により、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 — System object のコードが P コードであるためにソースコードが使用できない場合を除き、true

この引数は mfilename('class') として指定できます。

プロパティ

すべて展開する

`Title` — [ブロックパラメーター] ダイアログボックス内のヘッダーのタイトル
`''` (既定値) | string | 文字ベクトル

[ブロックパラメーター] ダイアログボックス内のヘッダーのタイトル。string または文字ベクトルとして指定します。既定では、タイトルは空の文字ベクトル ('') です。

例: 'AlternativeTitle'

属性:

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

データ型: string | char

`Text` — [ブロックパラメーター] ダイアログボックス内のタイトルの下に表示する説明テキスト
`''` (既定値) | string | 文字ベクトル

[ブロックパラメーター] ダイアログボックス内のタイトルの下に表示する説明テキスト。string または文字ベクトルとして指定します。既定では、テキストは空の文字ベクトル ('') です。

例: '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.