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

Стандартный интерфейс Set/Get

Некоторые 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

The get метод возвращает значение свойства объекта с помощью указателя на объект и имени свойства. Для примера примите H - указатель на объект:

v = get(H,'PropertyName');

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

CV = get(H,'PropertyName');

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

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

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

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

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

SV = get(H);

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

Для получения примера смотрите Использование get with Arrays of Handles.

Синтаксис метода Set

The 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)