% UTP_PLIST_PSET a set of UTPs for the plist/pset method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_pset.m,v 1.4 2010/09/02 17:50:44 nicolodi Exp $
%

% <MethodDescription>
%
% The pset method of the plist class set or add a key/value pair a
% param-object into the parameter list. Exist the key in the parameter list
% then becomes the value the new value.
%
% </MethodDescription>

function results = utp_plist_pset(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'plist';
    mthd    = 'pset';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    % Test PLIST objects
    pl1 = plist('a', 1);
    pl2 = plist('b', 2);
    pl3 = plist('c', 3);
    pl4 = plist('d', 4, 'e', 5);
    plv = [pl1, pl2, pl3];
    plm = [pl1, pl2; pl3 pl4];
    
    % 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 with different inputs for the key/value pair
    results = [results utp_08];    % Test setting and appending case.
    results = [results utp_09];    % Test capital letter of the key.
    
    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 pset method works with a vector of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Test that the pset method set or add a key/value pair to all PLIST
    % objects in the vector.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = pset(plv, 'new key', 'val');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the shape of the output is the same as the shape of the input
    % 2) Check that the output PLIST contains the new key/value pair.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check that the shape of the output is the same as the shape of the input
      if ~isa(out, 'plist') && size(out) == size(plv), atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plv)
        % The method plist/find is tested in the UTP utp_plist_find
        if ~isequal(out(ii).find('new key'), 'val'), 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 pset method works with a matrix of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Test that the pset method set or add a key/value pair to all PLIST
    % objects in the matrix.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = pset(plm, 'new key', 'val');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the shape of the output is the same as the shape of the input
    % 2) Check that the output PLIST contains the new key/value pair.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check that the shape of the output is the same as the shape of the input
      if ~isa(out, 'plist') && size(out) == size(plm), atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plm)
        % The method plist/find is tested in the UTP utp_plist_find
        if ~isequal(out(ii).find('new key'), 'val'), 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 pset method works with a list of PLIST objects as input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Test that the pset method set or add a key/value pair to all PLIST
    % objects in the input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = pset(pl1, pl2, pl3, 'new key', 'val');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the shape of the output is the same as the shape of the input
    % 2) Check that the output PLIST contains the new key/value pair.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [pl1, pl2, pl3];
    if stest
      % <AlgoCode>
      % Check that the shape of the output is the same as the shape of the input
      if ~isa(out, 'plist') && size(out) == size(plin), atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plin)
        % The method plist/find is tested in the UTP utp_plist_find
        if ~isequal(out(ii).find('new key'), 'val'), 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 pset method works with a mix of different shaped PLIST
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Test that the pset method set or add a key/value pair to all PLIST
    % objects in the input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = pset(plm, pl2, plv, 'new key', 'val');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the shape of the output is the same as the shape of the input
    % 2) Check that the output PLIST contains the new key/value pair.
    %
    % </AlgoDescription>
    
    atest = true;
    plin  = [reshape(plm, 1, []), pl2, reshape(plv, 1, [])];
    if stest
      % <AlgoCode>
      % Check that the shape of the output is the same as the shape of the input
      if ~isa(out, 'plist') && size(out) == size(plin), atest = false; end
      % Check that the output have all key/value pairs
      for ii = 1:numel(plin)
        % The method plist/find is tested in the UTP utp_plist_find
        if ~isequal(out(ii).find('new key'), 'val'), 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 pset method applies the modify command
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Test that the pset method can modify the input PLIST by calling with no
    % output and that the method doesn't change the input of the function
    % notation (with a equal sign).
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % copy at1 to work with
      pleq = plist(pl1);
      plmo = plist(pl1);
      % modify ain
      out = pleq.pset('new key', 'val');
      plmo.pset('new key', 'val');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that 'out' and 'pleq' are now different.
    % 2) Check that 'plmo' and 'out' are the same.
    % 3) Check that 'out' and 'plmo' have the new key/value pair
    % 4) Check that pleq don't have the new key/value pair
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check that 'out' and 'pleq' are not the same
      if eq(out, pleq, ple1), atest = false; end
      % Check that 'out' have the new key/value pair and 'pleq' not
      if ~isequal(out.find('new key'), 'val'), atest = false; end
      if isequal(pleq.find('new key'), 'val'), atest = false; end
      % Check 'plmo' have the new key/value pair
      if ~isequal(plmo.find('new key'), 'val'), atest = false; end
      % Check that 'out' and plmo are the same
      if ~eq(out, plmo, 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 pset method works for different input variants for the key/value
  % pair.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Test that the pset method accepts param-objects or direct key/value
    % pairs as an input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      p1   = param('p1', 1);
      p2   = param('p2', 2);
      p3   = param('p3', 3);
      out1 = pl1.pset([p1, p2], p3);
      out2 = pl1.pset('aa', 1, 'bb', 2);
      % In this case overwirtes the key 'p3' the value of the param p3
      out3 = pl1.pset(p1, 'aa', 1, [p2 p3], 'p3', 13);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output have all key/value pairs.
    %
    % </AlgoDescription>
    
    atest = true;
    try
      % do not run algorithm tests if sintax tests failed
      assert(stest);

      % <AlgoCode>
      % Check the key 'p1'
      assert(isequal(out1.find('p1'), 1));
      assert(isequal(out3.find('p1'), 1));
      % Check the key 'p2'
      assert(isequal(out1.find('p2'), 2));
      assert(isequal(out3.find('p2'), 2));
      % Check the key 'p3'
      assert(isequal(out1.find('p3'), 3));
      assert(isequal(out3.find('p3'), 13));
      % Check the key 'aa'
      assert(isequal(out2.find('aa'), 1));
      assert(isequal(out3.find('aa'), 1));
      % Check the key 'bb'
      assert(isequal(out2.find('bb'), 2));
      % </AlgoCode>
    catch ex
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07
  
  %% UTP_08
  
  % <TestDescription>
  %
  % Test the pset method in the setting and appending case.
  %
  % </TestDescription>
  function result = utp_08
    
    % <SyntaxDescription>
    %
    % Create an example where the pset method set a key to a new value and
    % an example where pset append the new key/value pair
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl_set = plist('a', 1, 'b', 2, 'c', 3);
      pl_app = plist('a', 1, 'b', 2, 'c', 3);
      pl_set.pset('a', 13);
      pl_app.pset('d', 13);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the number of parametes in the output.
    % 2) Check the new key/value pair
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check the correct number of paramter in the output
      if pl_set.nparams ~= 3, atest = false; end
      if pl_app.nparams ~= 4, atest = false; end
      % Check the new key/value pair
      if ~isequal(pl_set.find('a'), 13), atest = false; end
      if ~isequal(pl_app.find('d'), 13), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_08
  
  %% UTP_09
  
  % <TestDescription>
  %
  % Test that the pset method sets the key always in capital letter
  %
  % </TestDescription>
  function result = utp_09
    
    % <SyntaxDescription>
    %
    % Test that the pset method sets the key always in capital letter
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      out = pl2.pset('This_Id_A_NeW_Key', 1);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the key is in capital letters
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      for ii = 1:out.nparams
        found = false;
        if strcmp(out.params(ii).key, 'THIS_ID_A_NEW_KEY')
          found = true;
        end
      end
      if ~found, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_09
  
end
