octave_packages/m/general/saveobj.m

   1 ## Copyright (C) 2008-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {@var{b} =} saveobj (@var{a})
  21 ## Method of a class to manipulate an object prior to saving it to a file.
  22 ## The function @code{saveobj} is called when the object @var{a} is saved
  23 ## using the @code{save} function.  An example of the use of @code{saveobj}
  24 ## might be to remove fields of the object that don't make sense to be saved
  25 ## or it might be used to ensure that certain fields of the object are
  26 ## initialized before the object is saved.  For example:
  27 ##
  28 ## @example
  29 ## @group
  30 ## function b = saveobj (a)
  31 ##   b = a;
  32 ##   if (isempty (b.field))
  33 ##      b.field = initfield (b);
  34 ##   endif
  35 ## endfunction
  36 ## @end group
  37 ## @end example
  38 ##
  39 ## @seealso{loadobj, class}
  40 ## @end deftypefn
  41
  42 function b = saveobj (a)
  43   error ("saveobj: not defined for class \"%s\"", class(a));
  44 endfunction