1 ## Copyright (C) 2008-2012 David Bateman
3 ## This file is part of Octave.
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.
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.
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/>.
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:
30 ## function b = saveobj (a)
32 ## if (isempty (b.field))
33 ## b.field = initfield (b);
39 ## @seealso{loadobj, class}
42 function b = saveobj (a)
43 error ("saveobj: not defined for class \"%s\"", class(a));