addGroup

Добавьте новую группу настроек

свернуть все на странице

Синтаксис

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

Описание

пример

s = addGroup(parentgroup,name) добавляет новая группа настроек к заданной родительской группе настроек и возвращает SettingsGroup объект, содержащий новую группу настроек. По умолчанию группы настроек не скрыты, что означает, что они отображаются в родительской группе настроек.

пример

s = addGroup(___,Name,Value) задает свойства группы настроек с помощью одного или нескольких аргументов пары "имя-значение". Например, 'Hidden',true добавляет скрытая группа настроек. Задайте пары "имя-значение" после всех других входных параметров.

Примеры

свернуть все

Используйте settings функционируйте, чтобы получить доступ к корню дерева настроек и затем создать группу настроек mysettings.

s = settings;
newGroup = addGroup(s,'mysettings');
s
s = 
  SettingsGroup with properties:
                   matlab: [1×1 SettingsGroup]
               mysettings: [1×1 SettingsGroup]
    mldrivetripwireaccess: [1×1 SettingsGroup]

Используйте settings функционируйте, чтобы получить доступ к корню дерева настроек и затем создать скрытую группу настроек myhiddensettings. Заметьте, что новая группа не появляется, когда вы отображаете родительскую группу настроек.

s = settings;
addGroup(s,'myhiddensettings','Hidden',true);
s
s = 
  SettingsGroup with properties:
                   matlab: [1×1 SettingsGroup]
    mldrivetripwireaccess: [1×1 SettingsGroup]

Несмотря на то, что myhiddensettings не появляется в дереве настроек, это доступно. Например, создайте группу настроек myveryhiddensettings в myhiddensettings.

addGroup(s.myhiddensettings,'myveryhiddensettings');
s.myhiddensettings
s = 
  SettingsGroup 'matlab.myhiddensettings' with properties:
    myveryhiddensettings: [1×1 SettingsGroup]

Создайте группу настроек и задайте функцию валидации по умолчанию. Эта функция подтверждает значения всех настроек в группе, которые не имеют их собственных функций, определяемых валидации.

Во-первых, создайте функцию валидации numericValidationFcn это выдает ошибку, когда вход не является числовым.

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

Используйте settings функционируйте, чтобы получить доступ к корню дерева настроек и затем создать группу настроек mynumericsettings. Задайте функцию валидации numericValidationFcn.

s = settings;
newNumericGroup = addGroup(s,'mynumericsettings','ValidationFcn',@numericValidationFcn);

Теперь протестируйте, работает ли функция валидации. Создайте установку MyNonNumericSetting в mynumericsettings группа и установленный значение установки на нечисловое значение. Как ожидалось MATLAB® выдает ошибку.

addSetting(newvalidatedGroup,'MyNonNumericSetting','PersonalValue','Hello')
Error using matlab.settings.SettingsGroup/addSettingHelper
Unable to validate settings data. Error using numericValidationFcn (line 3)
Value must be numeric.

Error in matlab.settings.SettingsGroup/addSetting (line 74)
    out = obj.addSettingHelper(results,defaultsUsed);

Error in matlab.settings.SettingsGroup/addSetting (line 74)
    out = obj.addSettingHelper(results,defaultsUsed);

Входные параметры

свернуть все

Родительская группа настроек, чтобы добавить группу в в виде SettingsGroup объект. Используйте settings функционируйте, чтобы получить доступ к корневому групповому объекту настроек и всем доступным группам настроек.

Имя группы настроек, чтобы добавить в виде вектора символов или строкового скаляра. Если name уже существует в заданной родительской группе настроек, MATLAB выдает ошибку.

Аргументы в виде пар имя-значение

Задайте дополнительные разделенные запятой пары Name,Value аргументы. Name имя аргумента и Value соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Пример: addGroup(parentgroup,'myGroup','Hidden',true) добавляет новая скрытая группа настроек к заданной родительской группе настроек.

Скрытое состояние в виде true или false.

Когда установлено в true, группы настроек и настройки в группе не отображаются, несмотря на то, что они остаются доступными.

Функция, чтобы подтвердить настройки в группе в виде указателя на функцию. Когда задано, функция используется, чтобы подтвердить значения всех настроек в группе, которые не имеют их собственных функций, определяемых валидации.

Указатель на функцию должен быть сопоставлен с функцией, которая принимает потенциальное устанавливающее значение как входной параметр, не имеет никаких выходных аргументов и выдает ошибку, если валидация перестала работать.

Указатель на функцию должен указать на функцию на пути MATLAB. Указатели анонимной или вложенной функции не поддержаны.

Смотрите также

| | |

Темы

Введенный в R2019b

Документация MATLAB
Поддержка
Для просмотра документации необходимо авторизоваться на сайте