Exponenta Banner

addSetting

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

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

Синтаксис

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

Описание

пример

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заводская настройка не отображается в Командном окне или как часть заполнения клавишей Tab, хотя и остается доступной.

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

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

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

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

См. также

|

Темы

Введенный в R2019b

Документация MATLAB

Поддержка