% UTP_PLIST_STRING a set of UTPs for the plist/string method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_string.m,v 1.2 2009/07/22 14:02:26 ingo Exp $
%

% <MethodDescription>
%
% The string method of the plist class writes a command string that can be
% used to recreate the input object(s). But the object should not have more than
% one history step.
%
% </MethodDescription>

function results = utp_plist_string(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'plist';
    mthd    = 'string';

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

    % Test PLIST objects
    [pl1, pl2, pl3, pl4, plv, plm] = get_test_objects_plist;

    % 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];    % Negative test: The object have more than one history step.
    results = [results utp_07];    % Test different objects for 'val'

    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 ~= 0, atest = false; end
        % Check key
        % Check default value
        % Check options
      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 string method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the string method works for a vector of PLIST objects as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = string(plv);
      rout = eval(out);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output is a executable string.
    % 2) Check the correct number of rout
    % 3) Check the rebuild objects.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~ischar(out), atest = false; end;
      if ~isa(rout, 'plist'), atest = false; end
      if numel(rout) ~= numel(plv), atest = false; end
      for kk = 1:numel(plv)
        if eq(rout(kk), plv(kk)), atest = false; end
      end
      % </AlgoCode>
    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 string method works with a matrix of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the string method works for a matrix of PLIST objects as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = string(plm);
      rout = eval(out);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output is a executable string.
    % 2) Check the correct number of rout
    % 3) Check the rebuild objects.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the output
      if ~ischar(out), atest = false; end
      if ~isa(rout, 'plist'), atest = false; end
      if numel(rout) ~= numel(plm), atest = false; end
      for kk = 1:numel(plm)
        if eq(rout(kk), plm(kk)), atest = false; end
      end
      % </AlgoCode>
    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 string method works with a list of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the string method works for a list of PLIST objects as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = string(pl4,pl3);
      rout = eval(out);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output is a executable string.
    % 2) Check the correct number of rout
    % 3) Check the rebuild objects.
    %
    % </AlgoDescription>

    atest = true;
    plin  = [pl4, pl3];
    if stest
      % <AlgoCode>
      % Check the output
      if ~ischar(out), atest = false; end
      if ~isa(rout, 'plist'), atest = false; end
      if numel(rout) ~= numel(plin), atest = false; end
      for kk = 1:numel(plin)
        if eq(rout(kk), plin(kk)), atest = false; end
      end
      % </AlgoCode>
    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 string method works with a mix of different shaped PLIST objects
  % as input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Test that the string method works with an input of matrices and vectors
    % and single PLIST objects.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out  = string(pl4,plm,pl3);
      rout = eval(out);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output is a executable string.
    % 2) Check the correct number of rout
    % 3) Check the rebuild objects.
    %
    % </AlgoDescription>

    atest = true;
    plin  = [pl4, reshape(plm, 1, []), pl3];
    if stest
      % <AlgoCode>
      % Check the output
      if ~ischar(out), atest = false; end
      if ~isa(rout, 'plist'), atest = false; end
      if numel(rout) ~= numel(plin), atest = false; end
      for kk = 1:numel(plin)
        if eq(rout(kk), plin(kk)), atest = false; end
      end
      % </AlgoCode>
    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 string method doesn't work if the PLIST object have more
  % than one history step.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The method string throws an error because the input object have more than
    % one history step.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      iir = miir(plist('type', 'bandpass'));
      iir.setName('Second history step');
      pl = plist('filter', iir);
      out = pl.string();
      % </SyntaxCode>
      stest = false;
    catch err
      stest = true;
    end

    % <AlgoDescription>
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    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 string method accepts different objects for the 'val' property.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Create a plist with all possible objects for the 'val' property.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      iir = miir(plist('type', 'lowpass'));
      a = 'char';
      b = [1 2i 3; 4i 5 6];
      c = [true false true; false true false];
      d = java.util.TimeZone.getTimeZone('UTC');
      e = sym('[a b c; d e f]');
      f = plist('a', 'char');
      h = unit('m^-1/2 kg V^3/7');
      ii = [pz(3) pz(1,2) pz(1-2i) pz(-3)];
      j = [time(123) time('14:00:00')];
      k = [specwin('Kaiser', 10, 100) specwin('Hanning', 100)];
      % --- CHAR
      pl1 = plist('key', 'this is a char');
      % --- NUMERIC
      pl2 = plist('key', [1 2i 3; 4i 5 6]);
      % --- LOGICAL
      pl3 = plist('key', [true false true; false true false]);
      % --- JAVA (timezone)
      pl4 = plist('key', java.util.TimeZone.getTimeZone('UTC'));
      % --- SYM
      pl5 = plist('key', sym('[a b c; d e f]'));
      % --- PLIST
      pl6 = plist('key', plist('a', 'char'));
      % --- CELL
      cellval = {a b c d e f h ii j k};
      pl7 = plist('key', cellval);
      % --- STRUCT
      structval.a = a;
      structval.b = b;
      structval.c = c;
      structval.d = d;
      structval.e = e;
      structval.f = f;
      structval.h = h;
      structval.ii = ii;
      structval.j = j;
      structval.k = k;
      pl8 = plist('key', structval);
      % --- LTPDA_NUO
      % ------ HISTORY
      iir = miir(plist('type', 'lowpass'));
      pl9 = plist('key', iir.hist);
      % ------ UNITS
      pl10 = plist('key', unit('m^-1/2 kg V^3/7'));
      % ------ PARAM
      pl11 = plist('key', param('a', 'char'));
      % ------ PROVENANCE
      pl12 = plist('key', provenance);
      % ------ PZ
      pl13 = plist('key', [pz(3) pz(1,2) pz(1-2i) pz(-3)]);
      % ------ TIME
      pl14 = plist('key', [time(123) time('14:00:00')]);
      % ------ SPECWIN
      pl15 = plist('key', [specwin('Kaiser', 10, 100) specwin('Hanning', 100)]);
      out1  = eval(pl1.string);
      out2  = eval(pl2.string);
      out3  = eval(pl3.string);
      out4  = eval(pl4.string);
      out5  = eval(pl5.string);
      out6  = eval(pl6.string);
      out7  = eval(pl7.string);
      out8  = eval(pl8.string);
      out9  = eval(pl9.string);
      out10 = eval(pl10.string);
      out11 = eval(pl11.string);
      out12 = eval(pl12.string);
      out13 = eval(pl13.string);
      out14 = eval(pl14.string);
      out15 = eval(pl15.string);
      % </SyntaxCode>
      stest = true;
    catch err
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output is a executable string
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(pl1,  out1,  ple2), atest = false; end
      if ~eq(pl2,  out2,  ple2), atest = false; end
      if ~eq(pl3,  out3,  ple2), atest = false; end
      if ~eq(pl4,  out4,  ple2), atest = false; end
      if ~eq(pl5,  out5,  ple2), atest = false; end
      if ~eq(pl6,  out6,  ple2), atest = false; end
      if ~eq(pl7,  out7,  ple2), atest = false; end
      if ~eq(pl8,  out8,  ple2), atest = false; end
      if ~eq(pl10, out10, ple2), atest = false; end
      if ~eq(pl11, out11, ple2), atest = false; end
      if ~eq(pl12, out12, ple2), atest = false; end
      if ~eq(pl13, out13, ple2), atest = false; end
      if ~eq(pl14, out14, ple2), atest = false; end
      if ~eq(pl15, out15, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

end