matlab.settings.reloadFactoryFile

出荷時の設定の読み込みまたは再読み込み

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

構文

matlab.settings.reloadFactoryFile(toolboxName)

説明

matlab.settings.reloadFactoryFile(toolboxName) は、MATLAB® への出荷時の設定ツリーの読み込みまたは再読み込みを行います。matlab.settings.reloadFactoryFile を使用すると、MATLAB を再起動せずに、出荷時の設定ツリーを検査する前に更新できます。この関数はデバッグ専用であり、提供するツールボックスのコードに含めてはなりません。

メモ

  • matlab.settings.reloadFactoryFile は、settingsInfo.json ファイルの再読み込みを行いません。ファイルを変更した後に MATLAB を再起動しなければなりません。

  • matlab.settings.reloadFactoryFile を呼び出した後、指定のツールボックスを参照する変数があれば再作成しなければならない。たとえば、変数 a = s.mytoolbox を作成してから matlab.settings.reloadFactoryFile を呼び出す場合、mytoolbox の更新後の設定にアクセスするには a を再作成しなければなりません。

例

例

すべて折りたたむ

ツールボックスの出荷時ツリーを作成してから、ツリーが正しく作成されていることをテストします。

ツールボックス mytoolbox の出荷時の設定ツリーを作成する関数 createMyToolboxFactoryTree を作成します。

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

    toolboxFontGroup = addGroup(myToolboxFactoryTree,'font','Hidden',false)
    addSetting(toolboxFontGroup,'FontSize','FactoryValue',11,'Hidden',false, ...
        'ValidationFcn',@matlab.settings.mustBeNumericScalar)    
    addSetting(toolboxFontGroup,'FontColor','FactoryValue','Black', ...
        'Hidden',false,'ValidationFcn',@matlab.settings.mustBeStringScalar);
end

ツールボックスの settingsInfo.json ファイルを作成します。ルート設定グループ名として mytoolbox、設定ツリー作成関数として createMyToolboxFactoryTree を指定します。settingsInfo.json をツールボックスの resources フォルダーに配置します。

{
"ToolboxGroupName" : "mytoolbox",
"Hidden" : false,
"CreateTreeFcn" : "createMyToolboxFactoryTree"
}

設定ツリー作成関数を含むフォルダーとツールボックスのリソース フォルダーを MATLAB パスに追加します。次に、mytoolbox の出荷時の設定ツリーを読み込みます。

matlab.settings.reloadFactoryFile('mytoolbox');

関数 settings を使用して設定ツリーのルートにアクセスし、FontSize 設定の値を表示します。

s = settings;
s.mytoolbox.font.FontSize
ans = 
  Setting 'mytoolbox.font.FontSize' with properties:
       ActiveValue: 11
    TemporaryValue: <no value>
     PersonalValue: <no value>
      FactoryValue: 11

入力引数

すべて折りたたむ

出荷時設定の再読み込みを行う対象のツールボックスの名前。string スカラーまたは文字ベクトルとして指定します。

例: matlab.settings.reloadFactoryFile('mytoolbox');

バージョン履歴

R2019b で導入

参考

| | |

トピック