Exponenta Banner

addParamValue

(Не рекомендуемый), Добавляет дополнительный аргумент в виде пар "имя-значение" во входную схему синтаксического анализатора

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

addParamValue не рекомендуется. Используйте addParameter вместо этого.

Синтаксис

addParamValue(p,paramName,defaultVal)
addParamValue(p,paramName,defaultVal,validationFcn)

Описание

пример

addParamValue(p,paramName,defaultVal) добавляет название параметра дополнительного аргумента в виде пар "имя-значение" во входную схему синтаксического анализатора. Когда входные параметры к функции не включают эту дополнительную пару "имя-значение", входной синтаксический анализатор присваивает paramName значение defaultVal.

В отличие от позиционных входных параметров, добавленных с addRequired и функциями addOptional, каждый параметр, добавленный с addParamValue, соответствует двум входным параметрам: один для имени и один для значения.

addParamValue(p,paramName,defaultVal,validationFcn) задает функцию валидации для входного параметра.

Примеры

свернуть все

Подтвердите это, значение, соответствующее myParam, со значением по умолчанию 1, является числовым скаляром, больше, чем нуль.

Создайте входную схему синтаксического анализатора. Для функции валидации @(x) создает указатель на анонимную функцию, которая принимает входной параметр того.

p = inputParser;
paramName = 'myParam';
defaultVal = 1;
errorMsg = 'Value must be positive, scalar, and numeric.'; 
validationFcn = @(x) assert(isnumeric(x) && isscalar(x) ...
    && (x > 0),errorMsg);
addParamValue(p,paramName,defaultVal,validationFcn)

Проанализируйте недопустимый входной параметр, такой как -1.

parse(p,'myparam',-1)
The value of 'myparam' is invalid. Value must be positive, scalar, and numeric.

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

свернуть все

Введите схему синтаксического анализатора, заданную как объект inputParser.

Имя входного параметра, заданного как вектор символа или скаляр строки.

Пример: "firstName"

Пример: 'адрес'

Типы данных: char | string

Значение по умолчанию для входного параметра, заданного как любой тип данных. Если argName не является входным параметром к функции, когда функция parse анализирует входные параметры, то это присваивает argName значение defaultVal.

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

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

Пример: (s) isstring (s)

Пример: (x) isnumeric (x) &&isscalar (x)

Пример: (n) validateattributes (n, {'числовой'}, {'неотрицательный'})

Типы данных: function_handle

Советы

  • Пары "имя-значение" параметра являются дополнительными входными параметрами. При вызывании функции пары "имя-значение" могут появиться в любом порядке после позиционных параметров. Они принимают общую форму Name1,Value1,...,NameN,ValueN.

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

|

Темы

Представленный в R2007a

Была ли эта тема полезной?
Документация MATLAB
Поддержка