% UTP_PLIST_ISPARAM a set of UTPs for the plist/isparam method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_isparam.m,v 1.4 2009/07/22 14:02:26 ingo Exp $
%

% <MethodDescription>
%
% The isparam method of the plist class look for a given key in the
% parameter lists. Exist the key in the parameter list then is the result 1
% otherwise 0.
%
% </MethodDescription>

function results = utp_plist_isparam(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'plist';
    mthd    = 'isparam';
    
    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];    % Test the modify call works
    results = [results utp_07];    % Test positiv match.
    
    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 isparam method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Tests that the isparam method works with a vector of PLIST objects as
    % input. 
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = isparam(plv, 'non_existing_key');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output have the same size as the input.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if size(out) ~= size(plv), atest = false; end
      % Check the output. All must be zero because the key doesn't exit.
      if any(out), atest = false; 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 isparam method works with a matrix of PLIST objects as
  % input. 
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Tests that the isparam method works with a matrix of PLIST objects as
    % input. 
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = isparam(plm, 'non_existing_key');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output have the same size as the input.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if size(out) ~= size(plm), atest = false; end
      % Check the output. All must be zero because the key doesn't exit.
      if any(out), atest = false; 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 isparam method works with a list of PLIST objects as
  % input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Tests that the isparam method works with a list of PLIST objects as
    % input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = isparam(pl1, pl2, pl3, 'non_existing_key');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output have the same size as the input.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [pl1, pl2, pl3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if size(out) ~= size(plin), atest = false; end
      % Check the output. All must be zero because the key doesn't exit.
      if any(out), atest = false; 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 isparam method works with a mix of different shaped PLIST
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Tests that the isparam method works with a mix of different shaped
    % PLIST objects as input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = isparam(pl1, plv, plm, pl3, 'non_existing_key');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output have the same size as the input.
    % 2) Check the output.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [pl1, reshape(plv, 1, []), reshape(plm, 1, []), pl3];
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if size(out) ~= size(plin), atest = false; end
      % Check the output. All must be zero because the key doesn't exit.
      if any(out), atest = false; 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 isparam method applies the modify command
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the isparam method can used in the modifier form.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      plin = plist(pl3);
      plin.isparam('non_existing_key');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Test that plin doesn't change.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(plin, pl3, ple1), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06
  
  %% UTP_07
  
  % <TestDescription>
  %
  % Test the isparam method with a positiv match.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Test the isparam method with different input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out1 = pl2.isparam(pl2, 'a');
      out2 = pl2.isparam(pl2, 'b');
      out3 = pl2.isparam(pl2, 'c');
      out4 = pl2.isparam(pl2, 'd');
      out5 = isparam(pl1, pl2, pl3, 'cell');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the output
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 1, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 0, atest = false; end
      if ~isequal(out5,[0 0 1]), 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