addGroup

新しい設定グループの追加

ページ内をすべて折りたたむ

構文

s = addGroup(parentgroup,name)
s = addGroup(___,Name,Value)

説明

s = addGroup(parentgroup,name) は、指定した親設定グループに新しい設定グループを追加し、新しい設定グループを含む SettingsGroup オブジェクトを返します。既定では、設定グループは非表示ではありません。つまり、親設定グループ内に表示されます。

例

s = addGroup(___,Name,Value) は、1 つ以上の名前と値のペアの引数を使用して、設定グループのプロパティを指定します。たとえば、'Hidden',true は非表示の設定グループを追加します。名前と値のペアは他のすべての入力引数の後で指定します。

例

例

すべて折りたたむ

ライブ スクリプトを開く

関数 settings を使用して設定ツリーのルートにアクセスしてから、設定グループ mysettings を作成します。

s = settings;
newGroup = addGroup(s,"mysettings");
s
s = 
  SettingsGroup with properties:

    mysettings: [1×1 SettingsGroup]
        mytest: [1×1 SettingsGroup]
        matlab: [1×1 SettingsGroup]

removeGroup を使用して mysettings を削除します。

removeGroup(s,"mysettings");
s
s = 
  SettingsGroup with properties:

    mytest: [1×1 SettingsGroup]
    matlab: [1×1 SettingsGroup]
ライブ スクリプトを開く

関数 settings を使用して設定ツリーのルートにアクセスし、非表示の設定グループ myhiddensettings を作成します。新しいグループは非表示であるため、親設定グループを表示しても表示されません。

s = settings;
addGroup(s,"myhiddensettings",Hidden=true);
s
s = 
  SettingsGroup with properties:

    mytest: [1×1 SettingsGroup]
    matlab: [1×1 SettingsGroup]

myhiddensettings は、設定ツリーには表示されませんが、アクセスは可能です。たとえば、myhiddensettings 内に設定グループ myveryhiddensettings を作成できます。

addGroup(s.myhiddensettings,"myveryhiddensettings");
s.myhiddensettings
ans = 
  SettingsGroup 'myhiddensettings' with properties:

    myveryhiddensettings: [1×1 SettingsGroup]

非表示のグループは、表示されるグループと同じ方法で削除できます。

removeGroup(s,"myhiddensettings")
ライブ スクリプトを開く

設定グループを作成し、そのグループの既定の検証関数を指定します。この関数は、グループ内で独自の検証関数が定義されていないすべての設定の値を検証します。

入力が数値でない場合にエラーをスローする検証関数 numericValidationFcn を作成します。

function numericValidationFcn(x)
    errorMsg = "Value must be numeric."; 
    assert(isnumeric(x),errorMsg);
end

関数 settings を使用して設定ツリーのルートにアクセスしてから、設定グループ myNumericSettings を作成します。検証関数を指定します。

s = settings;
newNumericGroup = addGroup(s,"myNumericSettings",...
    ValidationFcn=@numericValidationFcn);

myNumericSettings グループ内に新しい設定を作成し、その設定の値を数値以外の値に設定しようとすると、MATLAB でエラーが発生します。たとえば、次のステートメントを実行すると、MATLAB でエラーが発生します。このステートメントは PersonalValue を数値ではなく string に設定しようとします。

addSetting(newNumericGroup,"mySetting",PersonalValue="Hello")

removeGroup を使用して myNumericSettings を削除します。

removeGroup(s,"myNumericSettings");

入力引数

すべて折りたたむ

グループの追加先の親設定グループ。SettingsGroup オブジェクトとして指定します。ルートの設定グループ オブジェクトおよび利用可能なすべての設定グループにアクセスするには、関数 settings を使用します。

追加する設定グループの名前。文字ベクトルまたは string スカラーとして指定します。指定した親設定グループに name が既に存在する場合、MATLAB® はエラーをスローします。また、addSetting や hasGroup など、SettingsGroup オブジェクトのメソッドの名前と name が一致している場合も MATLAB でエラーになります。

名前と値の引数

すべて折りたたむ

オプションの引数のペアを Name1=Value1,...,NameN=ValueN として指定します。ここで、Name は引数名で、Value は対応する値です。名前と値の引数は他の引数の後に指定しなければなりませんが、ペアの順序は重要ではありません。

R2021a より前では、コンマを使用して名前と値をそれぞれ区切り、Name を引用符で囲みます。

例: addGroup(parentgroup,'myGroup','Hidden',true) は、指定した親設定グループに新しい非表示の設定グループを追加します。

非表示の状態。true または false として指定します。

true に設定すると、設定グループおよびグループ内の設定は表示されませんが、アクセスは可能なままです。

グループ内の設定を検証する関数。関数ハンドルとして指定します。指定した関数は、グループ内で独自の検証関数が定義されていないすべての設定の値を検証するために使用されます。

関数ハンドルを関連付ける関数は、設定可能な値を入力引数として受け入れ、出力引数をもたず、検証が失敗した場合にエラーをスローするものでなければなりません。

関数ハンドルは、MATLAB パス上の関数をポイントしなければなりません。無名または入れ子の関数ハンドルはサポートされません。

バージョン履歴

R2019b で導入

参考

| | |

トピック