addSetting

新しい出荷時設定の追加

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

構文

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

説明

s = addSetting(parentgroup,name) は、指定した親出荷時グループに出荷時設定 name を追加し、新しい設定を FactorySetting として返します。既定では、出荷時設定は非表示です。つまり、親設定グループ内に表示されません。

例

s = addSetting(___,Name,Value) は、1 つ以上の名前と値のペアの引数を使用して、出荷時設定のプロパティを指定します。たとえば、'Hidden',false は、出荷時設定ツリーに表示される出荷時設定を作成します。名前と値のペアは他のすべての入力引数の後で指定します。

例

例

すべて折りたたむ

ツールボックス mytoolbox のルート出荷時グループを作成してから、新しい設定をツリーに追加します。

ルート出荷時グループ mytoolbox を作成します。

myToolboxFactoryTree = matlab.settings.FactoryGroup.createToolboxGroup('mytoolbox', ...
    'Hidden',false);

設定 FontSize を追加して、既定値を指定します。

fontSizeSetting = addSetting(myToolboxFactoryTree,'FontSize','FactoryValue',11,'Hidden',false);

設定を作成し、その値を検証する関数を指定します。

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

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

ルート出荷時グループ mytoolbox を作成します。

myToolboxFactoryTree = matlab.settings.FactoryGroup.createToolboxGroup('mytoolbox', ...
    'Hidden',false);

設定 FontSize を追加して、検証関数 numericValidationFcn を指定します。この設定が数値以外の値に設定されていると、MATLAB® はエラーをスローします。

addSetting(myToolboxFactoryTree,'FontSize','FactoryValue',11,'Hidden',false, ...
    'ValidationFcn',@numericValidationFcn);

入力引数

すべて折りたたむ

設定の追加先の親出荷時グループ。FactoryGroup オブジェクトとして指定します。関数 matlab.settings.FactoryGroup.createToolboxGroup を使用してルート出荷時グループ オブジェクトを作成します。

例: addSetting(s.mytoolbox,'newSetting')

追加する出荷時設定の名前。文字ベクトルまたは string として指定します。指定した親グループに出荷時設定 name が既に存在する場合、MATLAB はエラーを表示します。

例: addGroup(parentGroup,'newSetting')

名前と値の引数

すべて折りたたむ

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

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

例: addSetting(parentGroup,'newGroup','Hidden',false) は表示される出荷時グループを作成します。

設定の出荷時の値。ハンドル タイプを除く任意の型の MATLAB データとして指定します。ハンドルを含む cell 配列、struct、オブジェクトなどのデータ コンテナーもサポートされません。この設定には、出荷時の値または出荷時の値の関数のいずれかを指定しなければなりません (両方は不可)。

設定の出荷時の値を設定する関数。関数ハンドルとして指定します。設定の出荷時の値は、指定した関数の出力に設定されます。

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

この設定には、出荷時の値または出荷時の値の関数のいずれかを指定できます (両方は不可)。

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

true に設定した場合、出荷時の設定はコマンド ウィンドウやタブ補完の一部としては表示されませんが、アクセスは可能なままです。

読み取り専用の状態。true または false として指定します。true の場合、設定の個人用の値または一時的な値は設定できません。

設定値を検証する関数。関数ハンドルとして指定します。指定した関数は、出荷時設定の値を検証します。

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

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

バージョン履歴

R2019b で導入

参考

|

トピック