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.16 2008/02/13 10:13:53 ingo Exp $

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

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

 The following call returns a string that contains the routine CVS version:

 >> version = save(ao,'Version')

 The following call returns a string that contains the routine category:

 >> category = save(ao,'Category')

 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.16 2008/02/13 10:13:53 ingo 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 % The following call returns a string that contains the routine CVS version:
0023 %
0024 % >> version = save(ao,'Version')
0025 %
0026 % The following call returns a string that contains the routine category:
0027 %
0028 % >> category = save(ao,'Category')
0029 %
0030 % HISTORY: 14-02-07 M Hewitson
0031 %             Creation
0032 %
0033 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0034 
0035 ALGONAME = mfilename;
0036 VERSION  = '$Id: save.m,v 1.16 2008/02/13 10:13:53 ingo Exp $';
0037 CATEGORY = 'Output';
0038 
0039 % Check if this is a call for parameters
0040 if nargin == 2
0041   if isa(varargin{1}, 'ao') && ischar(varargin{2})
0042     in = char(varargin{2});
0043     if strcmp(in, 'Params')
0044       varargout{1} = getDefaultPL();
0045       return
0046     elseif strcmp(in, 'Version')
0047       varargout{1} = VERSION;
0048       return
0049     elseif strcmp(in, 'Category')
0050       varargout{1} = CATEGORY;
0051       return
0052     end
0053   end
0054 end
0055 
0056 if nargin ~= 2
0057   help mfilename;
0058   error('### incorrect inputs');
0059 end
0060 
0061 % get object
0062 obj = varargin{1};
0063 if isa(varargin{2}, 'plist')
0064   pl = varargin{2};
0065 elseif ischar(varargin{2})
0066   pl = plist(param('filename', varargin{2}));
0067 else
0068   help mfilename;
0069   error('### incorrect inputs');
0070 end
0071 
0072 % Save object
0073 ltpda_saveobj(obj, pl);
0074 
0075 % Get default params
0076 function plo = getDefaultPL()
0077 
0078 plo = plist();
0079 plo = append(plo, param('filename', 'object.xml'));
0080 
0081 
0082 % END

Generated on Mon 31-Mar-2008 13:54:54 by m2html © 2003