% UTP_TIMESPAN_CREATED a set of UTPs for the timespan/creator method
%
% M Hewitson 06-08-08
%
% $Id: utp_timespan_creator.m,v 1.2 2009/07/28 13:17:23 ingo Exp $
%

% <MethodDescription>
%
% The creator method of the timespan extract the creator(s)/modifier from
% the  history. Depending to the input parameter returns this method all
% creator/modifier or only the last creator/modifier.
%
% </MethodDescription>

function results = utp_timespan_creator(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'timespan';
    mthd    = 'creator';

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

    % Test TIMESPAN objects
    [ts1, ts2, ts3, ts4, ts5, ts6, tsv, tsm] = get_test_objects_timespan;

    % 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 with different creator/modifier
    results = [results utp_09];    % Test negative case for the option 'all'

    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 ~= 1, atest = false; end
        % Check key
        if ~io(3).plists.isparam('option'), atest = false; end
        % Check default value
        if ~isEmptyChar(io(3).plists.find('option')), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('option'), {''}), 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 creator method works with a vector of TIMESPAN objects as
  % input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      out = creator(tsv);
      % </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 'tsv'
    % 2) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(tsv), atest = false; end
      % Check the creator
      curr_creator = provenance();
      for kk=1:numel(out)
        if ~strcmp(out{kk}, curr_creator.creator), atest = false; break; 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 creator method works with a matrix of TIMESPAN objects as
  % input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      out = creator(tsm);
      % </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 'tsm'
    % 2) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(tsm), atest = false; end
      % Check creator
      curr_creator = provenance();
      for kk=1:numel(out)
        if ~strcmp(out{kk}, curr_creator.creator), atest = false; break; 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 creator method works with a list of TIMESPAN objects as
  % input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % The creator method doesn't work for a list of TIMESPAN objects as input.
    %
    % </SyntaxDescription>

    % <SyntaxCode>
    try
      creator(ts1,ts2,ts3);
      stest = false;
    catch
      stest = true;
    end
    % </SyntaxCode>

    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </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_04

  %% UTP_05

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

    % <SyntaxDescription>
    %
    % The creator method doesn't work with different shaped input objects.
    %
    % </SyntaxDescription>

      % <SyntaxCode>
    try
      creator(ts1,tsv,ts2,tsm,ts3);
      stest = false;
    catch
      stest = true;
    end
      % </SyntaxCode>

    % <AlgoDescription>
    %
    % 1) Nothing to test
    %
    % </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_05

  %% UTP_06

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

    % <SyntaxDescription>
    %
    % This method doesn't change the input object, thus no history is added
    % to the object.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Nothing to check.
    %
    % </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 creator method can be used with the modify command.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Tests that the creator method can be used with the modify command.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out1 = ts3.creator;
      out2 = tsm.creator;
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the single object
    % 2) Check the matrix object
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      curr_creator = provenance();
      % Check the single object
      if ~strcmp(out1, curr_creator.creator), atest = false; end
      % For a single object must be the the output a char string
      if ~ischar(out1), atest = false; end
      % Check the matrix
      for kk = 1:numel(out2)
        if ~strcmp(out2{kk}, curr_creator.creator), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end

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

  %% UTP_08

  % <TestDescription>
  %
  % Tests that the creator method retruns all creator(s)/modifier(s) which
  % are in the history.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the creator method uses the option 'all' direct or in a
    % plist. The test file must have the modifier 'first', 'second' and
    % 'third'
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Read object with different modifier
      ts  = timespan('test_timespan_diff_creator.xml');
      out1 = ts.creator;
      out2 = ts.creator('all');
      out3 = ts.creator(plist('option', 'all'));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that out1 contains only one creator
    % 2) Check that out2 contain more creator/modifier
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if ~ischar(out1), atest = false; end
      if ~strmatch('fist',   out2), atest = false; end
      if ~strmatch('second', out2), atest = false; end
      if ~strmatch('third',  out2), atest = false; end
      if ~strmatch('fist',   out3), atest = false; end
      if ~strmatch('second', out3), atest = false; end
      if ~strmatch('third',  out3), 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>
  %
  % Tests the negative case for the option 'all'.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test that the creator method throws an error if the option 'all' is
    % used in connection with a matrix/vector of TIMESPAN objects.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      tsm.creator('all');
      stest = false;
      % </SyntaxCode>
    catch
      stest = true;
    end

    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </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_09

end