% UTP_MFIR_STRING a set of UTPs for the mfir/string method
%
% M Hewitson 06-08-08
%
% $Id: utp_mfir_string.m,v 1.2 2009/07/23 12:33:01 ingo Exp $
%

% <MethodDescription>
%
% The string method of the mfir 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_mfir_string(varargin)

  % Check the inputs
  if nargin == 0

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

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

    fir1 = mfir(plist('type', 'lowpass'));
    fir2 = mfir(plist('type', 'highpass'));
    firv = [fir1, fir2, fir1];
    firm = [fir1, fir2, fir1; fir1, fir2, fir1];

    % 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];    % Negative test: The object have more than one history step.

    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 MFIR objects as input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      out  = string(firv);
      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, 'mfir'), atest = false; end
      if numel(rout) ~= numel(firv), atest = false; end
      for kk = 1:numel(firv)
        if eq(rout(kk), firv(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 MFIR objects as input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      out  = string(firm);
      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, 'mfir'), atest = false; end
      if numel(rout) ~= numel(firm), atest = false; end
      for kk = 1:numel(firm)
        if eq(rout(kk), firm(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 MFIR objects as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out  = string(fir1,fir2);
      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;
    firin  = [fir1, fir2];
    if stest
      % <AlgoCode>
      % Check the output
      if ~ischar(out), atest = false; end
      if ~isa(rout, 'mfir'), atest = false; end
      if numel(rout) ~= numel(firin), atest = false; end
      for kk = 1:numel(firin)
        if eq(rout(kk), firin(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 MFIR objects
  % as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out  = string(fir1,firm,fir2);
      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;
    firin  = [fir1, reshape(firm, 1, []), fir2];
    if stest
      % <AlgoCode>
      % Check the output
      if ~ischar(out), atest = false; end
      if ~isa(rout, 'mfir'), atest = false; end
      if numel(rout) ~= numel(firin), atest = false; end
      for kk = 1:numel(firin)
        if eq(rout(kk), firin(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 properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The method string doesn't change the data, thus it is not possible to check
    % the history. Nothing to do.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    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 doesn't work if the MFIR object have more
  % than one history step.
  %
  % </TestDescription>
  function result = utp_07

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

    try
      % <SyntaxCode>
      fir3  = mfir(plist('type', 'bandpass'));
      fir3.setName('Second history step');
      out = fir3.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_07

end