Home > classes > @mfir > save.m

save

PURPOSE ^

SAVE an mfir object to file.

SYNOPSIS ^

function varargout = save(varargin)

DESCRIPTION ^

 SAVE an mfir object to file.

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

 DESCRIPTION: SAVE overloads the save method for mfir objects.

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

 Parameters: 'filename' - name of the file

 VERSION:     $Id: save.m,v 1.2 2007/12/10 18:07:17 ingo Exp $

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

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

Generated on Tue 22-Jan-2008 10:39:13 by m2html © 2003