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

Свойство валидации Используя функции

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

Во время процесса валидации 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, их значения и функции MATLAB, используемые функциями валидации.

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

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

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

Например, класс ImData использует локальную функцию, чтобы задать блок проверки допустимости, который ограничивает свойство Data определенной областью значений числовых значений.

classdef ImData
   properties
      Data {mustBeNumeric, mustBeInRange(Data,[0,255])} = 0
   end
end
function mustBeInRange(a,b)
   if any(a(:) < b(1)) || any(a(:) > b(2))
      error(['Value assigned to Data property is not in range ',...
         num2str(b(1)),'...',num2str(b(2))])
   end
end

Когда вы создаете экземпляр класса ImData, MATLAB подтверждает это, значение по умолчанию является числовым, в области значений 0...255, и не пустым.

a = ImData

a = 

  ImData with properties:

    Data: 0

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

a.Data = 'red'

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

Присвоение числового значения, которое является вне области значений, вызывает ошибку, выданную mustBeInRange.

a.Data = -1

Error setting property 'Data' of class 'ImData':
Value assigned to Data property is not in range 0...255

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

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

Например, предположите, что вы хотите, чтобы ваш класс поддерживал функцию валидации 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.