ReleaseCompatibilityResults

Результаты обновления тулбокса с определенным номером версии

Описание

A ReleaseCompatibilityResults объект представляет результаты обновления личных параметров тулбокса для определенного номера версии.

Создание

Создайте ReleaseCompatibilityResults объект для определенного номера версии тулбокса при помощи matlab.settings.loadSettingsCompatibilityResults функция. Для примера эта команда получает ReleaseCompatibilityResults объект для 2 версий набора тулбоксов mytoolbox.

myCompatibilityResults = matlab.settings.loadSettingsCompatibilityResults('mytoolbox','Version2')

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

Свойства

расширить все

Выполняется обновление тулбокса версии до, заданное как строковый скаляр.

Пример: 'Version2'

Первое исключение предварительной валидации, заданное как ReleaseCompatibilityException объект. PreValidationExceptions является первым исключением, которое происходит при проверке деревьев личных и заводских настроек перед обновлением личных настроек. Если исключения не происходит, PreValidationExceptions массив 0 на 0 из ReleaseCompatibilityException объекты.

Результаты обновления, заданные как массив VersionResults объекты.

Примеры

свернуть все

Создайте функции для создания, а затем обновите заводское дерево тулбокса, а затем проверьте, что обновление успешно завершено.

Функция 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 с пустым matlab.settings.SettingsFileUpgrader объект.

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 функции как изменения в дереве настроек для версии 2 от mytoolbox.

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

Получите результаты обновления для версии 2 от mytoolbox.

matlab.settings.loadSettingsCompatibilityResults('mytoolbox','Version2')
ans = 
  ReleaseCompatibilityResults with properties:
               VersionLabel: "Version2"
    PreValidationExceptions: [0×0 matlab.settings.ReleaseCompatibilityException]
                    Results: [1×1 matlab.settings.VersionResults]
Введенный в R2019b
Для просмотра документации необходимо авторизоваться на сайте