exponenta event banner

addSetting

Добавить новый заводской параметр

Описание

пример

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

пример

s = addSetting(___,Name,Value) задает свойства настройки фабрики, используя один или несколько аргументов пары имя-значение. Например, 'Hidden',false создает параметр фабрики, видимый в дереве параметров фабрики. Укажите пары имя-значение после всех других входных аргументов.

Примеры

свернуть все

Создание корневой группы фабрики для панели инструментов mytoolbox а затем добавьте в дерево новый параметр.

Создание корневой группы фабрики mytoolbox.

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

Добавить параметр FontSize и присвойте ему значение по умолчанию.

fontSizeSetting = addSetting(myToolboxFactoryTree,'FontSize','FactoryValue',11,'Hidden',false);

Создайте параметр и укажите функцию для проверки ее значения.

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

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

Создание корневой группы фабрики mytoolbox.

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

Добавить параметр FontSize и укажите функцию проверки numericValidationFcn. MATLAB ® выдает ошибку всякий раз, когда для параметра установлено нечисловое значение.

addSetting(myToolboxFactoryTree,'FontSize','FactoryValue',11,'Hidden',false, ...
    'ValidationFcn',@numericValidationFcn);

Входные аргументы

свернуть все

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

Пример: addSetting(s.mytoolbox,'newSetting')

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

Пример: addGroup(parentGroup,'newSetting')

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

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

Пример: addSetting(parentGroup,'newGroup','Hidden',false) создает видимую группу фабрики.

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

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

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

Для параметра можно указать значение фабрики или функцию значения фабрики, но не оба параметра.

Скрытое состояние, указано как true или false.

Если установлено значение true, заводская настройка не отображается в окне команд или при заполнении вкладки, хотя она остается доступной.

Состояние только для чтения, указанное как true или false. Когда true, невозможно задать личное или временное значение параметра.

Функция для проверки значения параметра, указанного как дескриптор функции. Если указано, функция проверяет значение заводского параметра.

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

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

Представлен в R2019b