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 から取得されたプロパティ値がオーバーライドされます。

例

入力引数

すべて展開する

MATLAB System ブロックの System object。System object として指定します。System object を Header クラス コンストラクターの入力として指定した場合、コンストラクターによって作成されたインスタンスでは、System object に基づいてプロパティが設定されます。

  • Title — System object の名前

  • Text — System object のヘルプ概要

  • ShowSourceLink — System object のコードが P コードであるためにソース コードが使用できない場合を除き、true

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

プロパティ

すべて展開する

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

例: 'AlternativeTitle'

属性:

GetAccess
public
SetAccess
public

データ型: string | char

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

例: 'An alternative class description'

属性:

GetAccess
public
SetAccess
public

データ型: string | char

[ブロック パラメーター] ダイアログ ボックスでソース コードへのリンクを表示するオプション。'true' または 'false' として指定します。

属性:

GetAccess
public
SetAccess
public

データ型: string | char

例

すべて折りたたむ

クラス定義ファイルでヘッダーを定義します。

 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.

バージョン履歴

R2013b で導入

参考

| |

トピック