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

Функции проверки 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 как методы в классе:

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.