Home > classes > @param > save.m

save

PURPOSE ^

SAVE a param object to file.

SYNOPSIS ^

function varargout = save(varargin)

DESCRIPTION ^

 SAVE a param object to file.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: SAVE overloads the save method for param objects.

 CALL:        Save a param object as a .mat file.
                >> save(p, 'blah.mat')
              Save a param object as an XML file.
                >> save(p, 'blah.xml')
              Save a param object to file specified in plist.
                >> save(p, plist)

 Parameters: 'filename' - name of the file

 VERSION:     $Id: save.m,v 1.9 2007/07/12 15:54:42 ingo Exp $

 The following call returns a parameter list object that contains the
 default parameter values:

 >> pl = save(param, 'Params')

 HISTORY: 28-08-07 M Hewitson
             Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 function varargout = save(varargin)
0002 
0003 % SAVE a param object to file.
0004 %
0005 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0006 %
0007 % DESCRIPTION: SAVE overloads the save method for param objects.
0008 %
0009 % CALL:        Save a param object as a .mat file.
0010 %                >> save(p, 'blah.mat')
0011 %              Save a param object as an XML file.
0012 %                >> save(p, 'blah.xml')
0013 %              Save a param object to file specified in plist.
0014 %                >> save(p, plist)
0015 %
0016 % Parameters: 'filename' - name of the file
0017 %
0018 % VERSION:     $Id: save.m,v 1.9 2007/07/12 15:54:42 ingo Exp $
0019 %
0020 % The following call returns a parameter list object that contains the
0021 % default parameter values:
0022 %
0023 % >> pl = save(param, 'Params')
0024 %
0025 % HISTORY: 28-08-07 M Hewitson
0026 %             Creation
0027 %
0028 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0029 
0030 % Check if this is a call for parameters
0031 if nargin == 2
0032   if isa(varargin{1}, 'param') && ischar(varargin{2})
0033     in = char(varargin{2});
0034     if strcmp(in, 'Params')
0035       varargout{1} = getDefaultPL();
0036       return
0037     end
0038   end
0039 end
0040 
0041 
0042 ALGONAME = mfilename;
0043 VERSION  = '$Id: save.m,v 1.9 2007/07/12 15:54:42 ingo Exp $';
0044 
0045 if nargin ~= 2
0046   help mfilename;
0047   error('### incorrect inputs');
0048 end
0049 
0050 % get object
0051 obj = varargin{1};
0052 if isa(varargin{2}, 'plist')
0053   pl = varargin{2};
0054 elseif ischar(varargin{2})
0055   pl = plist(param('filename', varargin{2}));
0056 else
0057   help mfilename;
0058   error('### incorrect inputs');
0059 end
0060 
0061 % Save object
0062 ltpda_saveobj(obj, pl);
0063 
0064 % Get default params
0065 function plo = getDefaultPL()
0066 
0067 disp('* creating default plist...');
0068 plo = plist();
0069 plo = append(plo, param('filename', 'object.xml'));
0070 disp('* done.');
0071 
0072 
0073 % END

Generated on Mon 03-Sep-2007 12:12:34 by m2html © 2003