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

Валидация свойства в определениях классов

Валидация свойства MATLAB^® позволяет вам установить определенные ограничения для значений свойств. Можно использовать валидацию, чтобы ограничить класс и размер значений свойств. Кроме того, можно использовать функции, чтобы установить критерии, которым должно соответствовать значение свойства. MATLAB задает набор функций валидации, и можно записать собственные функции валидации.

Использование валидации свойства является дополнительным в определениях классов.

Демонстрационный класс Используя валидацию свойства

Класс ValidateProps задает три свойства с валидацией.

classdef ValidateProps
   properties
      Location(1,3) double {mustBeReal, mustBeFinite}
      Label(1,:) char {mustBeMember(Label,{'High','Medium','Low'})} = 'Low'
      State(1,1) matlab.lang.OnOffSwitchState
   end
end

a = ValidateProps

a = 

  ValidateProps with properties:

    Location: [0 0 0]
       Label: 'Low'
       State: off

Порядок валидации

Когда значение присвоено свойству, включая значения по умолчанию, которые заданы в определении класса, MATLAB выполняет валидацию в этом порядке:

classdef ValueProp
   properties
      Value(1,1) double {mustBeNonnegative} = 0
   end
end

a.Value = {10,20};

Error setting property 'Value' of class 'ValueProp':
Invalid data type. Value must be double or be convertible to double.

a.Value = [10 20];

Error setting property 'Value' of class 'ValueProp':
Size of value must be scalar.

a.Value = -10;

Error setting property 'Value' of class 'ValueProp':
Value must be nonnegative.

Абстрактная валидация свойства

Вы можете валидация свойства define для абстрактных свойств. Валидация применяется ко всем подклассам, которые реализуют свойство. Однако подклассы не могут использовать валидацию на своей реализации свойства. При наследовании валидации для свойства от нескольких классов только одно свойство Abstract в одном суперклассе может задать валидацию. Ни один из суперклассов не может задать свойство как некраткий обзор.

Объекты, не обновленные при изменении валидации

Если вы изменяете валидацию свойства, в то время как объекты класса существуют, MATLAB не пытается применить новую валидацию к существующим значениям свойств. Однако MATLAB действительно применяет новую валидацию, когда вы делаете присвоения на свойства существующих объектов.

Валидация во время операции загрузки

При сохранении объекта в файл MAT MATLAB сохраняет все значения свойств не по умолчанию с объектом. При загрузке объекта MATLAB восстанавливает эти значения свойств в недавно созданном объекте.

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

Чтобы проиллюстрировать это поведение, этот пример создает, сохраняет и загружает объект класса MonthTemp. Этот класс ограничивает свойство AveTemp массивом ячеек.

classdef MonthTemp
   properties
      AveTemp cell 
   end
end

Создайте объект MonthTemp и присвойте значение свойству AveTemp.

a = MonthTemp;
a.AveTemp = {'May',70};

Сохраните объект с помощью save.

save TemperatureFile a

Отредактируйте определение свойства, чтобы изменить класс валидации для свойства AveTemp от массива ячеек до containers.Map.

classdef MonthTemp
   properties
      AveTemp containers.Map
   end
end

Загрузите сохраненный объект с новым определением класса на пути MATLAB. MATLAB не может присвоить сохраненное значение свойству AveTemp, потому что массив ячеек, {'May',70}, не совместим с текущим требованием, чтобы значение свойства было объектом containers.Map. MATLAB не может преобразовать массив ячеек в containers.Map.

Чтобы обратиться к несовместимости, MATLAB устанавливает свойство AveTemp загруженного объекта к текущему значению по умолчанию, которое является пустым объектом containers.Map.

load TemperatureFile a
 a.AveTemp

ans = 

  Map with properties:

        Count: 0
      KeyType: char
    ValueType: any

Загруженному объекту присвоили различное значение свойству AveTemp, потому что сохраненное значение теперь недопустимо. Однако процесс загрузки подавляет ошибку валидации.

Чтобы предотвратить потерю данных при изменении определений классов и перезагрузке объектов, реализуйте метод loadobj или метод конвертера класса, который позволяет сохраненным значениям удовлетворить текущую валидацию свойства.

Для получения дополнительной информации о сохранении и загружаемых объектах, смотрите, Сохраняют и Процесс Загрузки для Объектов.