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

% <MethodDescription>
%
% The created method of the timespan returns a time object of the last
% modification. For this uses the created method the 'proctime' property of
% the last history step and computs from this value a timeobject.
%
% </MethodDescription>

function results = utp_timespan_created(varargin)

  % Check the inputs
  if nargin == 0

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

    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 empty object

    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 created method works with a vector of TIMESPAN objects as
  % input.
  %
  % </TestDescription>
  function result = utp_02

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

    try
      % <SyntaxCode>
      out = created(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 that the output is a time object
      if ~isa(out, 'time'), atest = false; end
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(tsv)), atest = false; end
      % Check the time-object
      for kk=1:numel(out)
        if out(kk).utc_epoch_milli ~= tsv(kk).hist.proctime, 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 created method works with a matrix of TIMESPAN objects as
  % input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      out = created(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 that the output is a time object
      if ~isa(out, 'time'), atest = false; end
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(tsm)), atest = false; end
      % Check time-object
      for kk=1:numel(out)
        if out(kk).utc_epoch_milli ~= tsm(kk).hist.proctime, 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 created method works with a list of TIMESPAN objects as
  % input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out = created(ts1,ts2,ts3);
      % </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
    %    input.
    % 2) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check that the output is a time object
      if ~isa(out, 'time'), atest = false; end
      % Check we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check each output against the input
      if out(1).utc_epoch_milli ~= ts1.hist.proctime, atest = false; end
      if out(2).utc_epoch_milli ~= ts2.hist.proctime, atest = false; end
      if out(3).utc_epoch_milli ~= ts3.hist.proctime, 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 created method works with a mix of different shaped
  % TIMESPAN objects as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out = created(ts1,tsv,ts2,tsm,ts3);
      % </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
    %    input.
    % 2) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    tsin = [ts1,reshape(tsv,1,[]),ts2,reshape(tsm,1,[]),ts3];
    if stest
      % <AlgoCode>
      % Check that the output is a time object
      if ~isa(out, 'time'), atest = false; end
      % Check we have the correct number of outputs
      if numel(out) ~= (3+numel(tsm)+numel(tsv)), atest = false; end
      for kk=1:numel(out)
        if out(kk).utc_epoch_milli ~= tsin(kk).hist.proctime, 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_05

  %% UTP_06

  % <TestDescription>
  %
  % Tests that the created 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 created method can be used with the modify command.
  %
  % </TestDescription>
  function result = utp_07

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

    try
      % <SyntaxCode>
      out1 = ts3.created;
      out2 = tsm.created;
      % </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>
      % Check the single object
      if out1.utc_epoch_milli ~= ts3.hist.proctime, atest = false; end
      % Check the matrix
      for kk = 1:numel(out2)
        if out2(kk).utc_epoch_milli ~= tsm(kk).hist.proctime, 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 created method retruns always a well defined time object
  % even for an empty input object.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the created method with an empty 'TIMESPAN object
    %
    % </SyntaxDescription>

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

    % <AlgoDescription>
    %
    % 1) Check that the output is a time object with a ell defined time.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if ~isa(out, 'time'), atest = false; end
      if isnan(out.utc_epoch_milli), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

end