% UTP_TIMESPAN_EQ a set of UTPs for the timespan/eq method
%
% M Hewitson 06-08-08
%
% $Id: utp_timespan_eq.m,v 1.12 2011/04/19 18:14:02 ingo Exp $
%

% <MethodDescription>
%
% The eq() method of the timespan class ts1 == ts2 compares each element of an
% ts object with the corresponding element of an second ts object and returns
% a logical 1 (true) where ts1 and ts2 are equal, or logical 0 (false)
% where they are not equal.
%
% </MethodDescription>

function results = utp_timespan_eq(varargin)

  % Check the inputs
  if nargin == 0

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

    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 with the exception list 'name'
    results = [results utp_08];    % Test with the exception list 'endT'
    results = [results utp_09];    % Test with the exception list 'startT'
    results = [results utp_12];    % Test exception list in a plist

    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 number of SETS
        if numel(io(2).sets) ~= 1, atest = false; end
        % Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        % SET 'Default'
        % Check key
        if ~io(3).plists.isparam('Exceptions'), atest = false; end
        if ~io(3).plists.isparam('Tol'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('Exceptions'), {}), atest = false; end
        if ~isequal(io(3).plists.find('Tol'), eps(1)), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('Exceptions'),   {{}}), atest = false; end
        if ~isequal(io(3).plists.getOptionsForParam('Tol'),    {eps(1)}), 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 eq method works with a vector of TIMESPAN objects as input.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the eq method works for a vector of TIMESPAN objects as input.
    % Test the positive and the negative case.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = ts3.setName('my name');
      tsv1 = [ts5, ts4, ts2, ts3];
      tsv2 = [ts5, ts4, ts2, ts];
      out1 = eq(tsv1, tsv1);
      out2 = eq(tsv1, tsv2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output of the eq function.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 1, atest = false; end
      if out2 ~= 0, 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 eq method works with a matrix of TIMESPAN objects as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the eq method works for a matrix of TIMESPAN objects as input.
    % Test the positive and the negative case.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = ts3.setName('my name');
      tsm1 = [ts5, ts4, ts3, ts3, ts2, ts5];
      tsm2 = [ts5, ts4, ts;  ts3, ts2, ts5];
      out1 = eq(tsm1, tsm1);
      out2 = eq(tsm1, tsm2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output of the eq function.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 1, atest = false; end
      if out2 ~= 0, 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 eq method works with a list of TIMESPAN objects as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % The eq method doesn't works for a list of TIMESPAN objects as input.
    % 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_04

  %% UTP_05

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

    % <SyntaxDescription>
    %
    % The eq method doesn't works for a list of TIMESPAN objects as input.
    % 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_05

  %% UTP_06

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

    % <SyntaxDescription>
    %
    % The eq method doesn't change the TIMESPAN object, thus will no history added.
    % 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>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'name'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because ts is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = testCallerIsMethod(@setName, ts3, 'my name');
      out1 = eq(ts, ts3);
      out2 = eqLocal(ts, ts3, 'name');
      out3 = eqLocal(ts, ts3, 'timespan/name');
      out4 = eq(ts.hist, ts3.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 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

  %% UTP_08

  % <TestDescription>
  %
  % Test the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'endt'. Use the option 'internal' to
    % suppress the history. It is necessary to add 'created' to the exception
    % list because ts is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = testCallerIsMethod(@setEndT, ts3, time(1234));
      out1 = eq(ts, ts3);
      out2 = eqLocal(ts, ts3, 'endT');
      out3 = eqLocal(ts, ts3, 'timespan/endT');
      out4 = eq(ts.hist, ts3.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, 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 the eq method with an exception list.
  % With the LTPDA toolbox 2.0 it is only possible to test the exception list
  % with properties where a public set method exist.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Test the eq method with the exception 'startT'. Use the option 'internal'
    % to suppress the history. It is necessary to add 'created' to the exception
    % list because ts is created at an other time.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = testCallerIsMethod(@setStartT, ts3, time(1234));
      out1 = eq(ts, ts3);
      out2 = eqLocal(ts, ts3, 'startT');
      out3 = eqLocal(ts, ts3, 'timespan/startT');
      out4 = eq(ts.hist, ts3.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  
  %% UTP_12

  % <TestDescription>
  %
  % Test the eq method with an exception list which is in a plist.
  %
  % </TestDescription>
  function result = utp_12

    % <SyntaxDescription>
    %
    % Test that the eq method uses the exception list in a plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = testCallerIsMethod(@setName, ts3, 'my name');
      pl = plist('Exceptions', {'name', 'UUID'});
      out1 = eq(ts, ts3);
      out2 = eq(ts, ts3, pl);
      out3 = eq(ts, ts3, pl);
      out4 = eq(ts.hist, ts3.hist);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the output.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the shape of the output data
      if out1 ~= 0, atest = false; end
      if out2 ~= 1, atest = false; end
      if out3 ~= 1, atest = false; end
      if out4 ~= 1, atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

  function res = eqLocal(obj1, obj2, ex)    
      e = ple1.find('EXCEPTIONS');
      if ~iscell(e)
        e = cellstr(e);
      end
      if ~iscell(ex)
        ex = cellstr(ex);
      end
      ple = plist('EXCEPTIONS', [e, ex, {'interval', 'time_str'}]);
    
      res = eq(obj1, obj2, ple);
  end
end