34.2 Методы класса

Существует ряд основных методов класса, которые можно (и нужно) определить для возможности запроса и изменения содержимого классов. Самый базовый из них — метод disp. Метод disp используется Octave при отображении класса на экране. Обычно это происходит в результате выражения Octave, которое не заканчивается точкой с запятой. Если этот метод не определен, то Octave ничего не выведет при отображении содержимого класса, что может быть запутанно.

Пример метода disp для класса полиномов может быть

function disp (p)

  a = p.poly;
  first = true;
  for i = 1 : length (a);
    if (a(i) != 0)
      if (first)
        first = false;
      elseif (a(i) > 0 || isnan (a(i)))
        printf (" +");
      endif
      if (a(i) < 0)
        printf (" -");
      endif
      if (i == 1)
        printf (" %.5g", abs (a(i)));
      elseif (abs (a(i)) != 1)
        printf (" %.5g *", abs (a(i)));
      endif
      if (i > 1)
        printf (" X");
      endif
      if (i > 2)
        printf (" ^ %d", i - 1);
      endif
    endif
  endfor

  if (first)
    printf (" 0");
  endif
  printf ("\n");

endfunction

Для согласованности с классами графических объектов Octave, класс также должен определять методы get и set. Метод get принимает один или два аргумента. Первый аргумент — объект соответствующего класса. Если второй аргумент не указан, метод должен вернуть структуру со всеми свойствами класса. Если необязательный второй аргумент указан, он должен быть именем свойства, и указанное свойство должно быть извлечено.

function val = get (p, prop)

  if (nargin < 1 || nargin > 2)
    print_usage ();
  endif

  if (nargin == 1)
    val.poly = p.poly;
  else
    if (! ischar (prop))
      error ("@polynomial/get: PROPERTY must be a string");
    endif

    switch (prop)
      case "poly"
        val = p.poly;
      otherwise
        error ('@polynomial/get: invalid PROPERTY "%s"', prop);
    endswitch
  endif

endfunction

Аналогично, первый аргумент для метода set должен быть объектом, а любые дополнительные аргументы — парами «свойство/значение».

function pout = set (p, varargin)

  if (numel (varargin) < 2 || rem (numel (varargin), 2) != 0)
    error ("@polynomial/set: expecting PROPERTY/VALUE pairs");
  endif

  pout = p;
  while (numel (varargin) > 1)
    prop = varargin{1};
    val  = varargin{2};
    varargin(1:2) = [];
    if (! ischar (prop) || ! strcmp (prop, "poly"))
      error ("@polynomial/set: invalid PROPERTY for polynomial class");
    elseif (! (isreal (val) && isvector (val)))
      error ("@polynomial/set: VALUE must be a real vector");
    endif

    pout.poly = val(:).';  # force row vector
  endwhile

endfunction

Обратите внимание, что Octave не реализует передачу по ссылке. Поэтому для изменения объекта требуется оператор присваивания, использующий возвращаемое значение метода set.

p = set (p, "poly", [1, 0, 0, 0, 1]);

Метод set использует метод subsasgn класса, и поэтому этот метод также должен быть определен. Метод subsasgn более подробно обсуждается в следующем разделе (см. Индексирование объектов).

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

p = polynomial ([1, 0, 1]);
save userclass.mat p
clear p
load userclass.mat

Поддерживаются все форматы файлов, поддерживаемые save и load. В некоторых случаях пользовательский класс может содержать поле, которое не имеет смысла сохранять, или поле, которое необходимо инициализировать перед сохранением. Это можно сделать с помощью метода saveobj класса.

: b = saveobj (a)

Метод класса для обработки объекта перед сохранением его в файл.

Функция saveobj вызывается при сохранении объекта a с помощью функции save. Пример использования saveobj может заключаться в удалении полей объекта, которые не имеют смысла сохранять, или в обеспечении инициализации определенных полей объекта перед сохранением объекта. Например:

function b = saveobj (a)
  b = a;
  if (isempty (b.field))
     b.field = initfield (b);
  endif
endfunction

См. также: loadobj, class.

saveobj вызывается непосредственно перед сохранением класса в файл. Аналогично, метод loadobj вызывается сразу после загрузки класса из файла и может использоваться для обеспечения повторного вставки удаленных полей в пользовательский объект.

: b = loadobj (a)

Метод класса для обработки объекта после загрузки его из файла.

Функция loadobj вызывается при загрузке объекта a с помощью функции load. Пример использования saveobj может заключаться в добавлении полей к объекту, которые не имеют смысла сохранять. Например:

function b = loadobj (a)
  b = a;
  b.addmissingfield = addfield (b);
endfunction

См. также: saveobj, class.