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

Поддержка

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