matlab.system.display.Header クラス

パッケージ: matlab.system.display
スーパークラス:

System object プロパティのヘッダー

構文

matlab.system.display.Header(N1,V1,...Nn,Vn)
matlab.system.display.Header(Obj,...)


説明

matlab.system.display.Header(N1,V1,...Nn,Vn) は、名前と値 (N,V) のペアで定義されたヘッダー プロパティを使って、System object™ のヘッダーを指定します。getHeaderImpl メソッド内で matlab.system.display.Header を使用します。使用可能なヘッダー プロパティは次のとおりです。

• Title — ヘッダー タイトル。既定値は空の文字ベクトルです。

• Text — ヘッダーの説明。既定値は空の文字ベクトルです。

• ShowSourceLink — オブジェクトのソース コードへのリンクを表示します。

matlab.system.display.Header(Obj,...) は、指定された System object (Obj) のヘッダーを作成し、次のプロパティ値を設定します。

• Title — Obj クラス名に設定します。

• Text — Obj のヘルプ概要に設定します。

• ShowSourceLink — Obj が MATLAB コードの場合、true に設定します。この場合、[ソース コード] リンクが表示されます。Obj が P コードでソース コードが使用できない場合、このプロパティを false に設定します。

このメソッド内から mfilename('class') を使用して System object の名前を取得することができます。任意の名前と値のペアを設定した場合、そのプロパティ値は既定の設定をオーバーライドします。

例

System ブロック ヘッダーの定義

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

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

結果の出力は以下のようになります。この場合、ShowSourceLink プロパティが true に設定されたため、[ソース コード] が表示されます。

参考

getHeaderImpl | matlab.system.display.Section | matlab.system.display.SectionGroup

トピック

• クラス
• ヘッダーの説明の追加