matlab.system.display.SectionGroup クラス

名前空間: matlab.system.display

MATLAB System ブロックの [ブロックパラメーター] ダイアログボックスでプロパティの入れ子にされたグループを作成する

説明

getPropertyGroupsImpl メソッド内で matlab.system.display.SectionGroup クラスを使用して、MATLAB System ブロックの [ブロックパラメーター] ダイアログボックス用に作成したカスタム要素をグループ化します。セクショングループには、matlab.system.display.Section クラスを使用して作成したセクション、System object™ プロパティのグループ、および matlab.system.display.Action クラスを使用して作成したカスタムボタンを含めることができます。

セクションと共にセクショングループを使用することで、ダイアログボックス内にプロパティの入れ子にされたグループを作成できます。たとえば、セクショングループで [ブロックパラメーター] ダイアログボックス内にタブを実装し、そのタブ内の 1 つ以上のセクションに折りたたみ可能なパネルを作成できます。

クラス属性

Sealed true

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

作成

説明

例

sectGrp = matlab.system.display.SectionGroup(Name,Value) は、1 つ以上の名前と値の引数を使用して定義されたプロパティが含まれたセクショングループを作成します。

sectGrp = matlab.system.display.SectionGroup(sysObj) は、System object sysObj に基づいて定義されたプロパティが含まれたセクショングループを作成します。

sectGrp = matlab.system.display.SectionGroup(sysObj,Name,Value) は、System object sysObj および 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 section 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

`Sections` — セクショングループに含めるセクション
`matlab.system.display.Section`

セクショングループに含めるセクション。matlab.system.display.Section クラスの 1 つ以上のインスタンスとして指定します。

属性:

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

データ型: matlab.system.display.Section

`Type` — セクショングループのセクションのタイプ
`matlab.system.display.SectionType.tab` (既定値) | `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

例

すべて折りたたむ

MATLAB System ブロックの [ブロックパラメーター] ダイアログボックスでのセクショングループの定義

System object のクラス定義ファイルで、getPropertyGroupsImpl メソッドを使用して、MATLAB System ブロックの [ブロックパラメーター] ダイアログボックスに 2 つのタブを定義します。各タブは、異なるプロパティ値を設定するためのアクセスを提供します。

classdef MultipleGroupsWithSectionGroup < matlab.System

    properties
        StartValue = 0
        EndValue = 10
        Threshold = 1
        BlockLimit = 55
    end

    properties(Nontunable)
        IC1 = 0
        IC2 = 10
        IC3 = 100
        UseThreshold (1,1) logical = true
    end
    
    methods (Static, Access = protected)
        function groups = getPropertyGroupsImpl
            alwaysSection = matlab.system.display.Section(...
                'Title','','PropertyList',{'BlockLimit'});
           
            initTab = matlab.system.display.SectionGroup(...
                'Title','Initial conditions', ...
                'PropertyList',{'IC1','IC2','IC3'},...
                'GroupType', matlab.system.display.SectionType.group);
            
            valueSection = matlab.system.display.Section(...
                'Title','Value parameters',...
                'PropertyList',{'StartValue','EndValue'},...
                'SectionType',...
                matlab.system.display.SectionType.collapsiblepanel);
            
            thresholdSection = matlab.system.display.Section(...
                'Title','Threshold parameters',...
                'PropertyList',{'Threshold','UseThreshold'},...
                'SectionType',...
                matlab.system.display.SectionType.collapsiblepanel);
            
            mainTab = matlab.system.display.SectionGroup(...
                'Title','Main', ...
                'Sections',[valueSection thresholdSection],...
                'GroupType',matlab.system.display.SectionType.group);
            
            groups = [alwaysSection mainTab initTab];
        end
    end
end

オブジェクトを MATLAB System ブロックに追加すると、ブロックの [ブロックパラメーター] ダイアログボックスには以下が含まれます。

上部にあるヘッダー
制限パラメーターのセクション
値およびしきい値パラメーターの折りたたみ可能なパネルが含まれているメインセクショングループ
下部にある初期条件セクション

The Block Parameters dialog box for the MATLAB System block for the System object that contains the example code has the Value parameters collapsible panel expanded and the Threshold parameters collapsible panel collapsed. The Value parameters section includes text fields to set the Start Value and End Value parameters.

The Block Parameters dialog box for the MATLAB System block for the System object that contains the example code has the Value parameters panel collapsed and the Threshold parameters panel expanded. The Threshold parameters section includes a text field to set the Threshold parameter and a check box to set the Use threshold parameter.

バージョン履歴

R2013b で導入

参考

matlab.system.display.Header | matlab.system.display.Section | getPropertyGroupsImpl

トピック

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

matlab.system.display.SectionGroup クラス

説明

クラス属性

作成

説明

入力引数

sysObj — MATLAB System ブロックの System object System object

プロパティ

Title — プロパティ グループ タイトル '' (既定値) | string | 文字ベクトル

属性:

TitleSource — プロパティ グループ タイトルのソース 'Property' (既定値) | 'Auto'

属性:

Description — プロパティ グループの説明 '' (既定値) | string | 文字ベクトル

属性:

PropertyList — セクション グループの最上位レベル内で設定できるプロパティ {} (既定値) | 文字ベクトルの cell 配列

属性:

Sections — セクション グループに含めるセクション matlab.system.display.Section

属性:

Type — セクション グループのセクションのタイプ matlab.system.display.SectionType.tab (既定値) | matlab.system.display.SectionType

属性:

AlignPrompts — コンテナー内のプロンプトの整列を制御するオプション true または 1 (既定値) | false または 0

属性:

例

MATLAB System ブロックの [ブロック パラメーター] ダイアログ ボックスでのセクション グループの定義

バージョン履歴

参考

トピック

`sysObj` — MATLAB System ブロックの System object
System object

`Title` — プロパティグループタイトル
`''` (既定値) | string | 文字ベクトル

`TitleSource` — プロパティグループタイトルのソース
`'Property'` (既定値) | `'Auto'`

`Description` — プロパティグループの説明
`''` (既定値) | string | 文字ベクトル

`PropertyList` — セクショングループの最上位レベル内で設定できるプロパティ
`{}` (既定値) | 文字ベクトルの cell 配列

`Sections` — セクショングループに含めるセクション
`matlab.system.display.Section`

`Type` — セクショングループのセクションのタイプ
`matlab.system.display.SectionType.tab` (既定値) | `matlab.system.display.SectionType`

`AlignPrompts` — コンテナー内のプロンプトの整列を制御するオプション
`true` または `1` (既定値) | `false` または `0`

MATLAB System ブロックの [ブロックパラメーター] ダイアログボックスでのセクショングループの定義