matlab.settings.loadSettingsCompatibilityResults

将工具箱的个人设置升级到特定版本的结果

全页折叠

语法

results = matlab.settings.loadSettingsCompatibilityResults(toolboxName,version)

说明

results = matlab.settings.loadSettingsCompatibilityResults(toolboxName,version) 获取将指定工具箱的个人设置升级到指定版本的结果，并将它们以 ReleaseCompatibilityResults 对象的形式返回。此函数仅用于调试目的，不应包含在正式发布的工具箱代码中。

运行 matlab.settings.loadSettingsCompatibilityResults 之后，请在再次运行该函数之前删除结果日志。删除日志可确保始终加载正确的升级结果。日志位于设置文件夹中的 toolboxname 文件夹中。

示例

示例

全部折叠

创建并升级一个工具箱出厂树，然后测试升级是否成功完成。

创建函数 createMyToolboxFactoryTree，该函数为工具箱 mytoolbox 创建出厂设置树。

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

    toolboxFontGroup = addGroup(myToolboxFactoryTree,"font",Hidden=false)
    addSetting(toolboxFontGroup,"MyFontSize",FactoryValue=11,Hidden=false, ...
        ValidationFcn=@matlab.settings.mustBeNumericScalar)    
    addSetting(toolboxFontGroup,"MyFontColor"FactoryValue="Black", ...
        Hidden=false,ValidationFcn=@matlab.settings.mustBeStringScalar);
end

使用空的设置文件升级程序对象创建函数 createMyToolboxSettingsFileUpgraders。

function upgraders = createMyToolboxSettingsFileUpgraders()
    upgraders = matlab.settings.SettingsFileUpgrader.empty;
end

为工具箱创建 settingsInfo.json 文件。指定 mytoolbox 为根设置组名称，createMyToolboxFactoryTree 为设置树创建函数，createMyToolboxSettingsFileUpgraders 为设置树升级函数。将 settingsInfo.json 放入工具箱 resources 文件夹中。

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

将包含设置树创建函数和工具箱资源文件夹的文件夹添加到 MATLAB® 路径。然后，加载 mytoolbox 的出厂设置树。

matlab.settings.reloadFactoryFile("mytoolbox");

使用 settings 函数访问设置树的根，并为 MyFontSize 设置设置个人值。

s = settings;
s.mytoolbox.font.MyFontSize.PersonalValue = 15;

将 createMyToolboxFactoryTree 中的设置名称从 MyFontSize 和 MyFontColor 更改为 FontSize 和 FontColor。

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

将 createMyToolboxSettingsFileUpgraders 函数中两个设置的重命名记录为对 mytoolbox 的版本 2 的设置树的更改。

function upgraders = createMyToolboxSettingsFileUpgraders()
    upgraders = matlab.settings.SettingsFileUpgrader("Version2"); 
    move(upgraders,"mytoolbox.font.MyFontSize","mytoolbox.font.FontSize"); 
    move(upgraders,"mytoolbox.font.MyFontColor","mytoolbox.font.FontColor");
end

重新加载 mytoolbox 的出厂设置树。

matlab.settings.reloadFactoryFile("mytoolbox");

使用 settings 函数访问设置树的根，并验证 FontSize 设置的个人值是否已从 MyFontSize 设置中正确移出。

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

获取 mytoolbox 的版本 2 的升级结果，以确定升级期间是否出现任何异常，以及是否成功执行了所有升级操作。

matlab.settings.loadSettingsCompatibilityResults("mytoolbox","Version2")
ans = 
  ReleaseCompatibilityResults with properties:
               VersionLabel: "Version2"
    PreValidationExceptions: [0×0 matlab.settings.ReleaseCompatibilityException]
                    Results: [1×1 matlab.settings.VersionResults]

输入参数

全部折叠

要获取升级结果的工具箱名称，指定为字符向量或字符串。

示例: "mytoolbox"

要获取升级结果的工具箱版本，指定为字符向量或字符串。

示例: "version2"

版本历史记录

在 R2019b 中推出

另请参阅

| |

主题