% UTP_AO_SAVE a set of UTPs for the ao/save method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_save.m,v 1.10 2010/08/31 09:36:46 hewitson Exp $
%

% <MethodDescription>
%
% The save method of the ao class saves an analysis object to disk. Save stores
% the variables in a MATLAB formatted file (MAT-file) named filename.mat or in a
% XML fromat named filename.xml
%
% </MethodDescription>

function results = utp_ao_save(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'ao';
    mthd    = 'save';

    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);

    % Exception list for the UTPs:
    [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();

    % Run the tests
    results = [results utp_01];    % getInfo call
    results = [results utp_02];    % Vector input
    results = [results utp_03];    % Matrix input
    results = [results utp_04];    % List input
    results = [results utp_05];    % Test with mixed input
    results = [results utp_06];    % Test history is working
    results = [results utp_07];    % Test the modify call works
    results = [results utp_08];    % Test plist contains the filename
    results = [results utp_09];    % Test object with complex data
    results = [results utp_10];    % Test AO which is build from a pzmodel
    results = [results utp_11];    % Test AO which is build from complex plist

    disp('Done.');
    disp('******************************************************');

  elseif nargin == 1 % Check for UTP functions
    if strcmp(varargin{1}, 'isutp')
      results = 1;
    else
      results = 0;
    end
  else
    error('### Incorrect inputs')
  end

  %% UTP_01

  % <TestDescription>
  %
  % Tests that the getInfo call works for this method.
  %
  % </TestDescription>
  function result = utp_01


    % <SyntaxDescription>
    %
    % Test that the getInfo call works for no sets, all sets, and each set
    % individually.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Call for no sets
      io(1) = eval([class '.getInfo(''' mthd ''', ''None'')']);
      % Call for all sets
      io(2) = eval([class '.getInfo(''' mthd ''')']);
      % Call for each set
      for kk=1:numel(io(2).sets)
        io(kk+2) = eval([class '.getInfo(''' mthd ''', ''' io(2).sets{kk} ''')']);
      end
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that getInfo call returned an minfo object in all cases.
    % 2) Check that all plists have the correct parameters.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % check we have minfo objects
      if isa(io, 'minfo')
        %%% SET 'None'
        if ~isempty(io(1).sets), atest = false; end
        if ~isempty(io(1).plists), atest = false; end
        %%% Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
        %%%%%%%%%%   SET 'Default'
        if io(3).plists.nparams ~= 4, atest = false; end
        % Check key
        if ~io(3).plists.isparam('filename'), atest = false; end
        if ~io(3).plists.isparam('prefix'), atest = false; end
        if ~io(3).plists.isparam('postfix'), atest = false; end
        if ~io(3).plists.isparam('individual files'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('filename'), ''), atest = false; end
        if ~isequal(io(3).plists.find('prefix'), ''), atest = false; end
        if ~isequal(io(3).plists.find('postfix'), ''), atest = false; end
        if ~isequal(io(3).plists.find('individual files'), false), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('filename'), {[]}), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_01

  %% UTP_02

  % <TestDescription>
  %
  % Tests that the save method works with a vector of AOs as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the save method works for a vector of AOs as input. Test both
    % formats 'xml' and 'mat'.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      save(atvec, 'test.xml');
      save(atvec, 'test.mat');
      out1 = ao('test.xml');
      out2 = ao('test.mat');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' and 'out2' are the same
    %    as in 'atvec'
    % 2) Check that the loaded objects are the same as the saved objects except
    %    the the history because the load-constructor adds one history step.
    % 3) The outputs 'out1' and 'out2' must be the same except the history
    %    properties 'methodInfo', 'plistUsed' and 'proctime'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out1), size(atvec)), atest = false; end
      if ~isequal(size(out2), size(atvec)), atest = false; end
      % Check each output against the input
      for kk=1:numel(out1)
        if ~eq(atvec(kk), out1(kk), ple1), atest = false; end
        if ~eq(atvec(kk), out2(kk), ple1), atest = false; end
      end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_02

  %% UTP_03

  % <TestDescription>
  %
  % Tests that the save method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the save method works for a matrix of AOs as input. Test both
    % formats 'xml' and 'mat'.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      save(atmat, 'test.xml');
      save(atmat, 'test.mat');
      out1 = ao('test.xml');
      out2 = ao('test.mat');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' and 'out2' are the same
    %    as in 'atmat'
    % 2) Check that the loaded objects are the same as the saved objects except
    %    the the history because the load-constructor adds one history step.
    % 3) The outputs 'out1' and 'out2' must be the same except the history
    %    properties 'methodInfo', 'plistUsed' and 'proctime'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out1), size(atmat)), atest = false; end
      if ~isequal(size(out2), size(atmat)), atest = false; end
      % Check each output against the input
      for kk=1:numel(out1)
        if ~eq(atmat(kk), out1(kk), ple1), atest = false; end
        if ~eq(atmat(kk), out2(kk), ple1), atest = false; end
      end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_03

  %% UTP_04

  % <TestDescription>
  %
  % Tests that the save method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the save method works for a list of AOs as input. Test both
    % formats 'xml' and 'mat'.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      save(at1, at2, at3, 'test.xml');
      save(at1, at2, at3, 'test.mat');
      out1 = ao('test.xml');
      out2 = ao('test.mat');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out1' and 'out2' are the same
    %    as in the list
    % 2) Check that the loaded objects are the same as the saved objects except
    %    the the history because the load-constructor adds one history step.
    % 3) The outputs 'out1' and 'out2' must be the same except the history
    %    properties 'methodInfo', 'plistUsed' and 'proctime'.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at1, at2, at3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= 3, atest = false; end
      if numel(out2) ~= 3, atest = false; end
      % Check each output against the input
      for kk=1:numel(out1)
        if ~eq(aoin(kk), out1(kk), ple1), atest = false; end
        if ~eq(aoin(kk), out2(kk), ple1), atest = false; end
      end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_04

  %% UTP_05

  % <TestDescription>
  %
  % Tests that the save method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Test that the save method works with an input of matrices and vectors
    % and single AOs. Test both formats 'xml' and 'mat'.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      save(at1,atvec,at2, 'test.xml');
      save(at1,atvec,at2, 'test.mat');
      out1 = ao('test.xml');
      out2 = ao('test.mat');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the number of elements in 'out' is the same as in
    %    input.
    % 2) Check that each output AO contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    aoin  = [at1, reshape(atvec, 1, []), at2];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out1) ~= 2+numel(atvec), atest = false; end
      if numel(out2) ~= 2+numel(atvec), atest = false; end
      % Check each output against the input
      for kk=1:numel(out1)
        if ~eq(aoin(kk), out1(kk), ple1), atest = false; end
        if ~eq(aoin(kk), out2(kk), ple1), atest = false; end
      end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_05

  %% UTP_06

  % <TestDescription>
  %
  % Tests that the save method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the save method can be processed back
    % to an m-file. Do this for both extensions 'mat' and 'xml'
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out1 = save(at4, 'test.xml');
      out2 = save(at2, 'test.mat');
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that save doesn't add a history step.
    % 2) Check that the read object is the same as the stored object.
    %    save + load doesn't add history.
    % 3) Check that the re-built object is the same object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % The last history step is the save method
      if strcmp(out1.hist.methodInfo.mname, 'save'), atest = false; end
      if strcmp(out2.hist.methodInfo.mname, 'save'), atest = false; end
      % check the history steps of the read object (load + save)
      outr1 = ao('test.xml');
      outr2 = ao('test.mat');
      if strcmp(outr1.hist.methodInfo.mname, 'ao'), atest = false; end
      if strcmp(outr2.hist.methodInfo.mname, 'ao'), atest = false; end
      % Check the re-built object
      if ~eq(mout1, out1, ple2), atest = false; end
      if ~eq(mout2, out2, ple2), atest = false; end
      % </AlgoCode>
      % delete test file
      delete('test.xml')
      delete('test.mat')
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06

  %% UTP_07

  % <TestDescription>
  %
  % Tests that the save method works with the modify command.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the modify command.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy at1 to work with
      aa_mat = ao(at1);
      aa_mat.save('test.mat');
      aa_xml = ao(at1);
      aa_xml.save('test.xml');
      out1 = ao('test.mat');
      out2 = ao('test.xml');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the save method applies the history.
    % 2) Check the output against the input except the history.
    % 3) Check the history of the output against the input.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check that the modified object have the 'save' method as the last
      % history step
      if strcmp(aa_xml.hist.methodInfo.mname, 'save'), atest = false; end
      if strcmp(aa_mat.hist.methodInfo.mname, 'save'), atest = false; end
      % Check the output without the history
      if ~eq(aa_mat, out1, ple1), atest = false; end
      if ~eq(aa_xml, out2, ple1), atest = false; end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07

  %% UTP_08

  % <TestDescription>
  %
  % Control the method with a plist.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the save method uses the filename which is stored in a plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pl1 = plist('filename', 'test.mat');
      pl2 = plist('filename', 'test.xml');
      save(at5, pl1);
      save(at5, pl2);
      out1 = ao('test.mat');
      out2 = ao('test.xml');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~eq(at5, out1, ple1), atest = false; end
      if ~eq(at5, out2, ple1), atest = false; end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_08

  %% UTP_09

  % <TestDescription>
  %
  % Test the save method with an AO with complex data.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Save an AO with complex fsdata object.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Create an AO with complex fsdata
      aa = ao(1:123, randn(123,1)+randn(123,1)*i, 1);
      aa.setT0(12345);
      save(aa, 'test.mat');
      save(aa, 'test.xml');
      out1 = ao('test.mat');
      out2 = ao('test.xml');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~eq(aa, out1, ple1), atest = false; end
      if ~eq(aa, out2, ple1), atest = false; end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_09

  %% UTP_10

  % <TestDescription>
  %
  % Test the save method with an AO which is created from a pole/zero model
  %
  % </TestDescription>
  function result = utp_10

    % <SyntaxDescription>
    %
    % Save an AO which is created from a pzmodel.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Create an AO with complex fsdata
      aa = ao(plist('pzmodel', pzmodel(1,{[1 4], 2}, 3), 'Nsecs', 10, 'fs', 37));
      save(aa, 'test.mat');
      save(aa, 'test.xml');
      out1 = ao('test.mat');
      out2 = ao('test.xml');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~eq(aa, out1, ple1), atest = false; end
      if ~eq(aa, out2, ple1), atest = false; end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_10

  %% UTP_11

  % <TestDescription>
  %
  % Test the save method with a complex plist which builds the AO
  %
  % </TestDescription>
  function result = utp_11

    % <SyntaxDescription>
    %
    % Save an AO which is created from a complex plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Create an AO with complex fsdata
      win = specwin('Hanning');
      pl  = plist('A', {'1', 2, sym('t')}, 'B', sym([1 2; 3 4]));
      pli = plist('vals', randn(123)+randn(123)*i, 'pl', pl, 'win', win);
      aa = ao(pli);
      save(aa, 'test.mat');
      save(aa, 'test.xml');
      out1 = ao('test.mat');
      out2 = ao('test.xml');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~eq(aa, out1, ple1), atest = false; end
      if ~eq(aa, out2, ple1), atest = false; end
      % Compare the outputs
      if ~eq(out1, out2, ple1), atest = false; end
      % </AlgoCode>
      delete('test.xml');
      delete('test.mat');
    else
      atest = false;
    end

    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_11

end