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

Функции валидации MATLAB

MATLAB^® определяет функции для использования в валидации свойств. Эти функции поддерживают общие шаблоны использования для валидации и предоставляют описательные сообщения об ошибке. В следующих таблицах классифицируются функции валидации MATLAB и описывается их использование.

Проверьте свойство с помощью функций

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

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

Список функций валидации MATLAB см. в разделе Функции валидации MATLAB.

classdef MyClass
   properties
      Prop {fcn1,fcn2,...} = defaultValue
   end
end

properties
   Prop {mustBeGreaterThan(Prop,10)}
end

classdef ValidatorFunction
   properties
      Data {mustBeNumeric, mustBeFinite}
      Interp {mustBeMember(Interp,{'linear','cubic','spline'})} = 'linear'
   end
end

a = ValidatorFunction

a = 

  ValidatorFunction with properties:

      Data: []
    Interp: 'linear'

a.Data = 'cubic'

Error setting property 'Data' of class 'ValidatorFunction':
Value must be numeric.

properties
   Data double {mustBeNumeric, mustBeFinite}
end

a.Data = 'cubic'

a = 

  ValidatorFunction with properties:

      Data: [99 117 98 105 99]
    Interp: 'linear'

a = ValidatorFunction;
a.Interp = 'cu'

Error setting property 'Interp' of class 'ValidatorFunction':
Value must be a member of this set
    linear
    cubic
    spline

classdef InterpMethod
   enumeration
      linear
      cubic
      spline
   end
end

classdef ValidatorFunction
   properties
      Data {mustBeNumeric, mustBeFinite}
      Interp InterpMethod
   end
end

a = ValidatorFunction;
a.Interp = 'cu'

a = 

  ValidatorFunction with properties:

      Data: []
    Interp: cubic

Определите функции валидации

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

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

Для примера, ImgData класс использует локальную функцию, чтобы задать валидатор, который ограничивает Data свойство только для uint8 или uint16 значения, исключающие подклассы и не допускающие преобразования из других числовых классов. Предопределенная функция валидации mustBeInRange ограничивает область значений допустимых значений.

classdef ImgData
    properties
        Data {mustBeImData(Data), mustBeInRange(Data,0,255)} = uint8(0)
    end
end
function mustBeImData(a)
    % Check for specific class     
    if ~(strcmp(cname, 'uint8') || strcmp(cname, 'uint16'))
        eidType = 'ImData:notUint8OrUint16';
        msgType = 'Value assigned to Data property is not uint8 or uint16 data.';
        throwAsCaller(MException(eidType,msgType))
    end
end

Когда вы создаете образец ImgData класс, MATLAB проверяет, что значение по умолчанию является uint8 или uint16 значение, в области значений 0...255, и не пустой. Обратите внимание, что значение по умолчанию должно удовлетворять требованиям валидации, как и любое другое значение, назначенное свойству.

a = ImgData

a = 

  ImgData with properties:

    Data: 0

Назначение свойств вызывает средства проверки в порядке слева направо. Назначение char вектор к Data свойство вызывает ошибку, выданную mustBeImData.

a.Data = 'red';

Error setting property 'Data' of class 'ImgData'. Value assigned to
Data property is not uint8 or uint16 data.

Назначение числового значения, которое находится вне области значений, приводит к ошибке, выданной mustBeInRange.

a.Data = uint16(312);

Error setting property 'Data' of class 'ImgData'. Value must be greater
than or equal to 0, and less than or equal to 255.

Для связанных функций смотрите mustBeInteger, mustBeNumeric, и mustBePositive.

Добавьте поддержку функций валидации

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

Например, предположим, что вы хотите, чтобы ваш класс поддерживал mustBeGreaterThan функции валидации. Перегрузите эти функции MATLAB как методы в вашем классе:

The SupportmBGT класс реализует поддержку mustBeGreaterThan.

classdef SupportmBGT
   properties
      Prop(1,1) double {mustBeReal}
   end
   methods
      function obj = SupportmBGT(data)
         if nargin > 0
            obj.Prop = data;
         end
      end
      function tf = isreal(obj)
         tf = true;
      end
      function tf = gt(obj1, obj2)
         tf = [obj1(:).Prop] > obj2.Prop;
      end
   end
end

Использование mustBeGreaterThan с объектами этого класса:

a = SupportmBGT(10);
b = SupportmBGT(12);
mustBeGreaterThan(a,b)

Error using mustBeGreaterThan (line 19)
Value must be greater than the comparison value.