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

Стандартный интерфейс набора/получения

Некоторые объекты MATLAB ®, например графические объекты, реализуют интерфейс на основеset и get функции. Эти функции обеспечивают доступ к нескольким свойствам массивов объектов в одном вызове функции.

Можно добавить set и get функциональные возможности для вашего класса путем получения одного из следующих классов:

Синтаксис подкласса

Использовать абстрактный класс matlab.mixin.SetGet или matlab.mixin.SetGetExactNames как суперкласс:

classdef MyClass < matlab.mixin.SetGet
   ...
end

Поскольку matlab.mixin.SetGet и matlab.mixin.SetGetExactNames производное от handle класс, ваш подкласс также является handle класс.

Получить синтаксис метода

get возвращает значение свойства объекта, используя дескриптор объекта и имя свойства. Например, предположим, что H является дескриптором объекта:

v = get(H,'PropertyName');

Если задан массив дескрипторов с одним именем свойства, get возвращает значение свойства для каждого объекта в виде массива ячеек значений:

CV = get(H,'PropertyName');

CV массив всегда является столбцом независимо от формы H.

Если задан массив ячеек char имена векторных свойств и массив дескрипторов, get возвращает массив ячеек значений свойств. Каждая строка в ячейке соответствует объекту в массиве дескрипторов. Каждый столбец в ячейке соответствует имени свойства.

props = {'PropertyName1','PropertyName2'};
CV = get(H,props);

get возвращает массив ячеек m-by-n, где m = length(H) и n = length(props).

Если задан массив дескрипторов, но имена свойств отсутствуют, get возвращает массив типа struct в которой каждая структура в массиве соответствует объекту в H. Каждое поле в каждой структуре соответствует свойству, определенному классом H. Значение каждого поля является значением соответствующего свойства.

SV = get(H);

Если выходная переменная не назначена, то H должен быть скалярным.

Пример см. в разделе Использование get с массивами дескрипторов.

Задать синтаксис метода

set метод присваивает указанное значение указанному свойству для объекта с дескриптором H. Если H является массивом дескрипторов, MATLAB присваивает значение свойству для каждого объекта в массиве H.

set(H,'PropertyName',PropertyValue)

Можно передать массив ячеек имен свойств и массив ячеек значений свойств в set:

props = {'PropertyName1','PropertyName2'};
vals = {Property1Value,Property2Value};
set(H,props,vals)

Если length(H) больше единицы, затем массив ячеек значения свойства (vals) может иметь значения для каждого свойства в каждом объекте. Например, предположим length(H) равно 2 (два дескриптора объекта). Для каждого объекта необходимо назначить два значения свойств:

props = {'PropertyName1','PropertyName2'};
vals = {Property11Value,Property12Value;Property21Value,Property22Value};
set(H,props,vals))

Предыдущий оператор эквивалентен следующим двум операторам:

set(H(1),'PropertyName1',Property11Value,'PropertyName2',Property12Value)
set(H(2),'PropertyName1',Property21Value,'PropertyName2',Property22Value)

Если указан скалярный дескриптор, но имена свойств отсутствуют, set возвращает struct с одним полем для каждого свойства в классе H. Каждое поле содержит пустой массив ячеек.

SV = set(h);

Класс, производный от matlab.mixin.SetGet

Этот образец класса определяет интерфейс set/get и иллюстрирует поведение унаследованных методов:

classdef LineType < matlab.mixin.SetGet
   properties
      Style = '-'
      Marker = 'o'
   end
   properties (SetAccess = protected)
      Units = 'points'
   end
   methods
      function obj = LineType(s,m)
         if nargin > 0
            obj.Style = s;
            obj.Marker = m;
         end
      end
      function set.Style(obj,val)
         if ~(strcmpi(val,'-') ||...
               strcmpi(val,'--') ||...
               strcmpi(val,'..'))
            error('Invalid line style ')
         end
         obj.Style = val;
      end
      function set.Marker(obj,val)
         if ~isstrprop(val,'graphic')
            error('Marker must be a visible character')
         end
         obj.Marker = val;
      end
   end
end

Создайте экземпляр класса и сохраните его дескриптор:

h = LineType('--','*');

Запрос значения любого свойства объекта с использованием унаследованного get способ:

get(h,'Marker')

ans =

'*'

Установка значения любого свойства с использованием унаследованного set способ:

set(h,'Marker','Q')

set(h,'Style','-.-')

Error using LineType/set.Style (line 20)
Invalid line style

h = LineType('--','*');
SV = get(h)

SV = 

  struct with fields:

     Style: '--'
    Marker: '*'
     Units: 'points'

S = set(h)

S = 

  struct with fields:

     Style: {}
    Marker: {}

H = [LineType('..','z'),LineType('--','q')]

H = 

  1x2 LineType with properties:

    Style
    Marker
    Units

CV = get(H,'Style')

CV =

  2×1 cell array

    {'..'}
    {'--'}

SV = get(H)

SV = 

2x1 struct array with fields:
    Style
    Marker
    Units

SV(2).Marker

ans =

'q'

H = [LineType('..','z'),LineType('--','q')];
set(H,{'Style','Marker'},{'..','o';'--','x'})

H(1)

ans = 

  LineType with properties:

     Style: '..'
    Marker: 'o'
     Units: 'points

H(2)

ans = 

  LineType with properties:

     Style: '--'
    Marker: 'x'
     Units: 'points'

Установить приоритет для сопоставления имен частичных свойств

Классы, производные от matlab.mixin.SetGet может использовать PartialMatchPriority атрибут свойства для указания относительного приоритета для частичного сопоставления имен. MATLAB применяет этот атрибут при разрешении неполных и не учитывающих регистр текстовых строк, которые соответствуют нескольким именам свойств.

Унаследованный set и get методы могут разрешать неактивные имена свойств при отсутствии неоднозначностей, возникающих в результате неаккуратных строк имен. Если имя частичного свойства неоднозначно, поскольку имя соответствует нескольким свойствам, PartialMatchPriority значение атрибута может определять, какое свойство MATLAB соответствует.

Приоритет по умолчанию эквивалентен PartialMatchPriority = 1. Чтобы уменьшить относительный приоритет свойства, задайте PartialMatchPriority к положительному целому значению 2 или больше. Приоритет свойства уменьшается при значении PartialMatchPriority увеличивается.

Например, в этом классе Verbosity свойство имеет более высокий приоритет для сопоставления имен, чем Version собственность.

classdef MyClass < matlab.mixin.SetGet
    properties
        Verbosity
    end
    properties (PartialMatchPriority = 2)
        Version
    end
end

Вызов set метод с потенциально неоднозначным неточным именем Ver устанавливает Verbosity свойство из-за более высокого относительного приоритета. Без настройки PartialMatchPriority , неоднозначное имя может привести к ошибке.

a = MyClass;
set(a,"Ver",10)
disp(a)

 MyClass with properties:

    Verbosity: 10
      Version: []

Выбор того же имени применяется к get способ.

v = get(a,"Ver")

v =

    10 

classdef MyClass < matlab.mixin.SetGet
    properties
        BaseLine
    end
    properties (PartialMatchPriority = 2)
        Base
    end
end

a = MyClass;
set(a,"base",-2)
disp(a)

 MyClass with properties:

    BaseLine: []
        Base: -2

classdef Planet < matlab.mixin.SetGet
% Version 1.0
    properties
        Distance
    end
    properties(PartialMatchPriority = 2)
        DiscreteSamples
    end
end

classdef Planet < matlab.mixin.SetGet
% Version 2.0
    properties
        Diameter;
        NumMoons = 0
        ApparentMagnitude;
        DistanceFromSun;
    end
    properties(PartialMatchPriority = 2)
        DiscreteSamples;
    end
    properties(PartialMatchPriority = 3)
        Discontinuities = false;
    end
end

p = Planet;
set(p,"Disc",true)