mustBeNumericOrLogical

Validate that the value of an object property is a numeric or logical value.

a = lettersPattern;
mustBeNumericOrLogical(a)

Value must be numeric or logical.

In this case, the value of the a property is a pattern object, which results in an error.

This class restricts the value of Prop1 to numeric values.

classdef MyClass
   properties
      Prop1 {mustBeNumericOrLogical}
   end
end

Create an object and assign a value to its property.

obj = MyClass;
obj.Prop1 = gca;

Error setting property 'Prop1' of class 'MyClass'. Value must be numeric or logical.

When you assign a value to the property, MATLAB^® calls mustBeNumericOrLogical with the value being assigned to the property. mustBeNumericOrLogical issues an error because the value assigned to Prop1 is a char vector.

function r = mbNumericOrLogical(x)
    arguments
        x (1,:) {mustBeNumericOrLogical}
    end
    p = [3 2 1];
    r = polyval(p,x);
end

Calling this function with a character vector results in an error being thrown by mustBeNumericOrLogical.

x = '4 3 2';
r = mbNumericOrLogical(x);

Error using mbNumericOrLogical (line 3)
 r = mbNumericOrLogical(x);
                        ^
Invalid argument at position 1. Value must be numeric or logical.