Home > classes > @ao > save.m

save

PURPOSE ^

SAVE overloads save operator for analysis objects.

SYNOPSIS ^

function varargout = save(varargin)

DESCRIPTION ^

 SAVE overloads save operator for analysis objects.

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

 DESCRIPTION: SAVE overloads save operator for analysis objects.

 CALL:        Save an analysis object as a .mat file.
                >> save(a, 'blah.mat')
              Save an analysis object as an XML file.
                >> save(a, 'blah.xml')

 Parameters: 'filename' - name of the file

 VERSION:     $Id: save.m,v 1.14 2008/01/07 20:41:19 hewitson Exp $

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

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

 HISTORY: 14-02-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 overloads save operator for analysis objects.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SAVE overloads save operator for analysis objects.
0007 %
0008 % CALL:        Save an analysis object as a .mat file.
0009 %                >> save(a, 'blah.mat')
0010 %              Save an analysis object as an XML file.
0011 %                >> save(a, 'blah.xml')
0012 %
0013 % Parameters: 'filename' - name of the file
0014 %
0015 % VERSION:     $Id: save.m,v 1.14 2008/01/07 20:41:19 hewitson Exp $
0016 %
0017 % The following call returns a parameter list object that contains the
0018 % default parameter values:
0019 %
0020 % >> pl = save(ao, 'Params')
0021 %
0022 % HISTORY: 14-02-07 M Hewitson
0023 %             Creation
0024 %
0025 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0026 
0027 
0028 ALGONAME = mfilename;
0029 VERSION  = '$Id: save.m,v 1.14 2008/01/07 20:41:19 hewitson Exp $';
0030 
0031 % Check if this is a call for parameters
0032 if nargin == 2
0033   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0034     in = char(varargin{2});
0035     if strcmp(in, 'Params')
0036       varargout{1} = getDefaultPL();
0037       return
0038     elseif strcmp(in, 'Version')
0039       varargout{1} = VERSION;
0040       return
0041     end
0042   end
0043 end
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 
0065 % % Check if this is a call for parameters
0066 % if nargin == 2
0067 %   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0068 %     in = char(varargin{2});
0069 %     if strcmp(in, 'Params')
0070 %       varargout{1} = getDefaultPL();
0071 %       return
0072 %     end
0073 %   end
0074 % end
0075 %
0076 %
0077 % ALGONAME = mfilename;
0078 % VERSION  = '$Id: save.m,v 1.14 2008/01/07 20:41:19 hewitson Exp $';
0079 %
0080 % if nargin ~= 2
0081 %   help mfilename;
0082 %   error('### incorrect inputs');
0083 % end
0084 %
0085 % % analysis object
0086 % a = varargin{1};
0087 % if isa(varargin{2}, 'plist')
0088 %   filename = find(varargin{2}, 'filename');
0089 %   plo = varargin{2};
0090 % else
0091 %   % filename
0092 %   filename = varargin{2};
0093 %   plo = plist(param('filename', filename));
0094 % end
0095 %
0096 % % Inspect filename
0097 % [path,name,ext,vers] = fileparts(filename);
0098 %
0099 % switch ext
0100 %   case '.mat'
0101 %
0102 %     save(filename, 'a');
0103 %
0104 %   case '.xml'
0105 %
0106 % %     hist = a.hist;
0107 % %     h = history(ALGONAME, VERSION, plo, hist);
0108 % %
0109 % %     a = set(a, 'hist', h);
0110 % %     a = set(a, 'name', sprintf('save(%s,%s)', a.name, filename));
0111 % %
0112 % %     % convert AO to xml
0113 % %     x = xml(a);
0114 % %     % Save the XML document.
0115 % %     xmlwrite(filename,x.docNode);
0116 %
0117 %   otherwise
0118 %     error('### unknown file extension.');
0119 % end
0120 %
0121 % % no outputs
0122 % if nargout == 1
0123 %   varargout{1} = a;
0124 % else
0125 %   for j=1:nargout
0126 %     varargout{j} = [];
0127 %   end
0128 % end
0129 
0130 % Get default params
0131 function plo = getDefaultPL()
0132 
0133 plo = plist();
0134 plo = append(plo, param('filename', ''));
0135 
0136 % END

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