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

Цель методов конструктора класса

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

Для основного примера смотрите, Создают Простой Класс.

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

Базовая структура методов конструктора

Методы конструктора могут быть структурированы в три основных раздела:

Этот код иллюстрирует основные операции, выполняемые в каждом разделе:

classdef ConstructorDesign < BaseClass1
   properties
      ComputedValue
   end
   methods
      function obj = ConstructorDesign(a,b,c)
         
         %% Pre Initialization %%
         % Any code not using output argument (obj)
         if nargin == 0
            % Provide values for superclass constructor
            % and initialize other inputs
            a = someDefaultValue;
            args{1} = someDefaultValue;
            args{2} = someDefaultValue;
         else
            % When nargin ~= 0, assign to cell array,
            % which is passed to supclass constructor
            args{1} = b;
            args{2} = c;
         end
         compvalue = myClass.staticMethod(a);
         
         %% Object Initialization %%
         % Call superclass constructor before accessing object
         % You cannot conditionalize this statement
         obj = obj@BaseClass1(args{:});
         
         %% Post Initialization %%
         % Any code, including access to object
         obj.classMethod(arg);
         obj.ComputedValue = compvalue;
         ...
      end
   ...
   end
...
end

Вызовите конструктора как любая функция, передающие аргументы и возврат объекта класса.

obj = ConstructorDesign(a,b,c);

Инструкции для конструкторов

Конструктор по умолчанию

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

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

Когда задать конструкторов

Задайте метод конструктора выполнить объектную инициализацию, которую не может выполнить конструктор по умолчанию. Например, когда создание объекта класса требует:

Сопутствующая информация

Для получения информации характерный для построения перечислений, смотрите Вызывающую последовательность Конструктора класса Перечисления.

Для получения информации о создании объектных массивов в конструкторе смотрите Построение Массивы объектов.

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

Инициализация объектов в конструкторе

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

Например, следующая функция конструктора может присвоить значение свойства A объекта как первый оператор, потому что объект obj был уже присвоен экземпляру myClass.

function obj = myClass(a,b,c)
   obj.A = a;
      ...
end

Можно вызвать другие методы класса от конструктора, потому что объект уже инициализируется.

Конструктор также создает объект, свойства которого имеют свои значения по умолчанию — или пустой ([]) или значение по умолчанию, заданное в блоке определения свойства.

Например, следующий код вызывает метод класса CalculateValue, чтобы присвоить значение свойства Value.

function obj = myClass(a,b,c)
   obj.Value = obj.CalculateValue(a,b);
      ...
end

% obj is the object being constructed
function obj = myClass(arg) 
   obj.propert1 = arg*10;
   obj.method1;
      ...
end

Вызов конструктора без входного аргумента

Существуют случаи, где конструктор должен смочь быть названным без входного параметра:

Если нет никаких входных параметров, конструктор создает объект с помощью только значения свойств по умолчанию. Хорошая практика должна добавить проверку на нулевые аргументы к конструктору класса, чтобы предотвратить ошибку, если любой из этих двух случаев происходит:

function obj = myClass(a,b,c)
   if  nargin > 0
      obj.A = a;
      obj.B = b;
      obj.C = c;
      ...
   end
end

Для способов обработать конструкторов суперкласса, смотрите Базовую структуру Методов конструктора.

Конструкторы подкласса

Методы конструктора подкласса могут явным образом вызвать конструкторов суперкласса, чтобы передать аргументы конструктору суперкласса. Конструктор подкласса должен задать эти аргументы в вызове конструктора суперкласса с помощью выходного аргумента конструктора. Вот синтаксис:

classdef MyClass < SuperClass 
   function obj = MyClass(arg)
      obj@SuperClass(SuperArgList);
         ...
   end
end

Конструктор класса должен выполнить все вызовы к конструкторам суперкласса перед любыми другими ссылками на объект (obj). Это ограничение включает значения свойств присвоения или вызов обычных методов класса. Кроме того, конструктор подкласса может вызвать конструктора суперкласса только однажды.

classdef MyClass < SuperClass

classdef Cube < Shape
   properties
      SideLength = 0
      Color = [0 0 0]
   end
   methods
      function cubeObj = Cube(length,color,upvector,viewangle)
         if nargin == 0
            super_args{1} = [0 0 1];
            super_args{2} = 10;
         elseif nargin == 4
            super_args{1} = upvector;
            super_args{2} = viewangle;
         else
            error('Wrong number of input arguments')
         end
         cubeObj@Shape(super_args{:});
         if nargin > 0 % Use value if provided
            cubeObj.SideLength = length;
            cubeObj.Color = color;
         end
         ...
      end
   ...
   end
end

methods
   function cubeObj = Cube(length,color,upvector,viewangle)
      if nargin == 0 
         super_args = {};
      elseif nargin == 4
         super_args{1} = upvector;
         super_args{2} = viewangle;
      else
         error('Wrong number of input arguments')
      end
      cubeObj@Shape(super_args{:});
      if nargin > 0 
         cubeObj.SideLength = length;
         cubeObj.Color = color;
      end
   ...
   end
end

Неявный вызов наследованного конструктора

MATLAB передает аргументы неявно от конструктора подкласса по умолчанию до конструктора суперкласса. Это поведение избавляет от необходимости реализовывать метод конструктора для подкласса только, чтобы передать аргументы конструктору суперкласса.

Например, следующий конструктор класса требует одного входного параметра (объект datetime), который конструктор присваивает свойству CurrentDate.

classdef BaseClassWithConstr
   properties
      CurrentDate datetime
   end
   methods
      function obj = BaseClassWithConstr(dt)
         obj.CurrentDate = dt;
      end
   end        
end

Предположим, что вы создаете подкласс BaseClassWithConstr, но ваш подкласс не требует метода явного конструктора.

classdef SubclassDefaultConstr < BaseClassWithConstr
   ...
end

Можно создать объект SubclassDefaultConstr путем вызова его конструктора по умолчанию с аргументом суперкласса:

obj = SubclassDefaultConstr(datetime);

Для получения информации о конструкторах подкласса см. Конструкторов подкласса и Конструктора по умолчанию.

Ошибки во время конструкции класса

Для классов Handle MATLAB вызывает метод delete, когда ошибка происходит при следующих условиях:

MATLAB вызывает метод delete на объекте, методы delete для любых объектов, содержавшихся в свойствах и методах delete для любых инициализированных базовых классов.

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

Для получения информации о том, как объекты уничтожаются, видят Деструктор Класса Handle.

Выведите подавленный объект

Можно подавить присвоение экземпляра класса к переменной ans, когда никакая выходная переменная не присвоена в вызове конструктора. Этот метод полезен для приложений, который создает окна графического интерфейса, которые содержат на созданные объекты. Эти приложения не должны возвращать объект.

Используйте nargout, чтобы определить, был ли конструктор вызван выходным аргументом. Например, конструктор класса для класса MyApp очищает переменную объекта, obj, если названо без присвоенного вывода:

classdef MyApp
   methods
      function obj = MyApp
         ...
         if nargout == 0
            clear obj
         end
      end
      ...
   end
end

Когда конструктор класса не возвращает объект, MATLAB не инициировал событие meta.class InstanceCreated.