matlab.system.display.Section クラス

名前空間: matlab.system.display

MATLAB System ブロックの [ブロック パラメーター] ダイアログ ボックスでプロパティ グループ セクションを作成する

説明

getPropertyGroupsImpl メソッド内で matlab.system.display.Section クラスを使用して、MATLAB System ブロックの [ブロック パラメーター] ダイアログ ボックスにプロパティ グループ セクションを追加します。プロパティ グループを使用して、ブロックの System object™ でプロパティを設定できます。

クラス属性

Sealed

true

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

作成

説明

propGroup = matlab.system.display.Section(Name,Value) は、MATLAB System ブロックの [ブロック パラメーター] ダイアログ ボックスでプロパティ グループ セクション propGroup を作成し、1 つ以上の名前と値の引数に従ってプロパティ グループのプロパティを設定します。

propGroup = matlab.system.display.Section(sysObj) は、プロパティ グループ セクション propGroup を作成し、System object obj に従ってプロパティ グループのプロパティを設定します。

propGroup = matlab.system.display.Section(sysObj,Name,Value) は、プロパティ グループ セクション paramGroup を作成し、System object obj および 1 つ以上の名前と値の引数に従ってプロパティ グループのプロパティを設定します。名前と値の引数を使用して指定したプロパティにより、System object から取得されたプロパティ値がオーバーライドされます。

入力引数

sysObj — MATLAB System ブロックの System object

System object

MATLAB System ブロックの System object。System object として指定します。

System object を入力引数として指定すると、プロパティ グループのこれらのプロパティ値は System object から取得されます。

• Title — System object の名前

• PropertyList — System object のすべてのパブリック プロパティ

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

プロパティ

Title — プロパティ グループ タイトル

'' (既定値) | string | 文字ベクトル

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

例: "My Property Group"

属性:

GetAccess	public
SetAccess	public

データ型: string | char

TitleSource — プロパティ グループ タイトルのソース

'Property' (既定値) | 'Auto'

プロパティ グループ タイトルのソース。次のオプションのいずれかとして指定します。

• 'Property' — セクション タイトルはプロパティ グループの Title プロパティから取得されます。

• 'Auto' — セクション タイトルは、コンストラクターの入力引数として指定された System object から取得されます。

属性:

GetAccess	public
SetAccess	public

データ型: string | char

Description — プロパティ グループの説明

'' (既定値) | string | 文字ベクトル

プロパティ グループの説明。string または文字ベクトルとして指定します。既定では、説明は空の文字ベクトル ('') です。

説明は、[ブロック パラメーター] ダイアログ ボックスでセクション内のすべてのプロパティより上に表示されます。

例: "My property group description."

属性:

GetAccess	public
SetAccess	public

データ型: string | char

PropertyList — プロパティ グループ内で設定できるプロパティ

{} (既定値) | 文字ベクトルの cell 配列

プロパティ グループ内で設定できるプロパティ。それぞれがプロパティの名前を定義する文字ベクトルの cell 配列として指定します。既定では、プロパティ リストは空の cell 配列 ({}) です。

System object をコンストラクターの入力引数として指定すると、名前と値の引数としてもプロパティ リストを指定して設定をオーバーライドしない限り、プロパティ リストは System object のすべてのパブリック プロパティに設定されます。

以下のタイプのプロパティは、[ブロック パラメーター] ダイアログ ボックス、および MATLAB^® コマンド ウィンドウで表示される概要で表示できません。

• 非表示のプロパティ

• 抽象プロパティ

• プライベート プロパティ

• アクセスが保護されているプロパティ

• 離散状態

• 連続状態

[ブロック パラメーター] ダイアログ ボックスでは依存プロパティを表示できませんが、これらのプロパティは MATLAB コマンド ウィンドウで表示した System object の概要で表示されます。

例: {'Property1' 'Property2'}

属性:

GetAccess	public
SetAccess	public

データ型: cell

Type — プロパティ グループのセクションのタイプ

matlab.system.display.SectionType

プロパティ グループのセクションのタイプ。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

AlignPrompts — コンテナー内のプロンプトの整列を制御するオプション

true または 1 | false または 0

コンテナー内のプロンプトの整列を制御するオプション。logical true (1) または logical false (0) として指定します。

属性:

GetAccess	public
SetAccess	public

データ型: logical

例

プロパティ グループの定義

タイトルとプロパティのリストを指定することで、クラス定義ファイルで 2 つのプロパティ グループを定義します。

 classdef MultipleGroupsWithSection < matlab.System
    properties
        StartValue = 0
        EndValue = 10
        Threshold = 1
    end

    properties(Nontunable)
        UseThreshold (1,1) logical = true
    end
    
    methods (Static, Access = protected)
        function groups = getPropertyGroupsImpl
            valueGroup = matlab.system.display.Section(...
                "PropertyList",{'StartValue','EndValue'},...
                "SectionType", matlab.system.display.SectionType.tab);

           thresholdGroup = matlab.system.display.Section(...
                "PropertyList",{'Threshold','UseThreshold'},...
                "SectionType", matlab.system.display.SectionType.tab);
           
           group1 = matlab.system.display.SectionGroup(...,
               "Title","Value parameters",...
               'Sections',valueGroup,...
               'Type',matlab.system.display.SectionType.tab);

           group2 = matlab.system.display.SectionGroup(...,
               "Title","Threshold parameters",...
               'Sections',thresholdGroup,...
               'Type',matlab.system.display.SectionType.tab);

           groups = [group1, group2];
        end
    end
end

MATLAB System ブロックで System object を指定すると、ブロックの [ブロック パラメーター] ダイアログ ボックスには、2 つのプロパティ グループに対応する 2 つのタブができます。

バージョン履歴

R2013b で導入

参考

matlab.system.display.Header | matlab.system.display.SectionGroup | getPropertyGroupsImpl

トピック

• プログラムによる System ブロック ダイアログ ボックスのカスタマイズ