matlab.settings.mustBeNumericScalar

Validate that setting value is numeric array with one element

Syntax

matlab.settings.mustBeNumericScalar(settingvalue)

Description

matlab.settings.mustBeNumericScalar(settingvalue) issues an error if settingvalue is not a numeric array with one element. This function does not return a value.

This function ignores input arguments that are empty values. Therefore, no error is thrown when the setting value is empty.

Examples

Validate That Setting Value Is Numeric Scalar

Create a setting and specify a function to validate that the setting value is a numeric scalar.

Create the settings group mysettings.

s = settings;
addGroup(s,'mysettings');

Add the setting MyNumericSetting to mysettings and specify the validation function matlab.settings.mustBeNumericScalar.

addSetting(s.mysettings,'MyNumericSetting','ValidationFcn',@matlab.settings.mustBeNumericScalar);

Now, test whether the validation function works. Set the value of MyNumericSetting to a nonnumeric value. As expected, MATLAB^® throws an error.

s.mysettings.MyNumericSetting.PersonalValue = 'Hello';

Error setting 'MyNumericSetting' in group 'mysettings': Value must be numeric.

Input Arguments

settingvalue — Setting value to validate

scalar

Setting value to validate, specified as a scalar of one of the following:

• Any MATLAB numeric class

• MATLAB classes that implement isscalar and isnumeric

Other data types cause an error.