% UTP_TIMESPAN_GET a set of UTPs for the timespan/get method
%
% M Hewitson 06-08-08
%
% $Id: utp_timespan_get.m,v 1.3 2011/03/29 13:03:29 ingo Exp $
%

% <MethodDescription>
%
% The get method of the timespan class returns the value of an object
% property. This is a very simple method which accepts only one timespan as
% input thus are the most general units test not possible.
%
% </MethodDescription>

function results = utp_timespan_get(varargin)

  % Check the inputs
  if nargin == 0

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

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

    % 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];    % Algorithm test
    results = [results utp_03];    % Algorithm test with a plist
    results = [results utp_04];    % Negative test with more than one timespan

    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('property'), atest = false; end
        % Check default value
        if ~isEmptyChar(io(3).plists.find('property')), atest = false; end
        % Check options
        if ~isequal(io(3).plists.getOptionsForParam('property'), {''}), 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 the get method of the timespan class.
  %
  % </TestDescription>
  function result = utp_02

    % <SyntaxDescription>
    %
    % Test that the get returns returns the value of the specified
    % property. Do this for all properties of the TIMESPAN object.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts = timespan('2008-08-08 12:00:00', '2008-08-08 13:00:00');
      out1 = get(ts, 'startT');
      out2 = get(ts, 'endT');
      out3 = get(ts, 'timeformat');
      out4 = get(ts, 'timezone');
      out5 = get(ts, 'interval');
      out7 = get(ts, 'hist');
      out8 = get(ts, 'name');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the correct value of the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(out1, ts.startT),          atest = false; end
      if ~eq(out2, ts.endT),            atest = false; end
      if ~isequal(out3, ts.timeformat), atest = false; end
      if ~isequal(out4, ts.timezone),   atest = false; end
      if ~isequal(out5, ts.interval),   atest = false; end
      if ~eq(out7, ts.hist),            atest = false; end
      if ~isequal(out8, ts.name),       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 get method works with a plist.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Test that the get returns returns the value of the specified
    % property which is defined in a plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts  = timespan('2008-08-08 12:00:00', '2008-08-08 13:00:00');
      pl1 = plist('property', 'startT');
      pl2 = plist('property', 'endT');
      pl3 = plist('property', 'timeformat');
      pl4 = plist('property', 'timezone');
      pl5 = plist('property', 'interval');
      pl7 = plist('property', 'hist');
      pl8 = plist('property', 'name');
      out1 = get(ts, pl1);
      out2 = get(ts, pl2);
      out3 = get(ts, pl3);
      out4 = get(ts, pl4);
      out5 = get(ts, pl5);
      out7 = get(ts, pl7);
      out8 = get(ts, pl8);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check the correct value of the output
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(out1, ts.startT),          atest = false; end
      if ~eq(out2, ts.endT),            atest = false; end
      if ~isequal(out3, ts.timeformat), atest = false; end
      if ~isequal(out4, ts.timezone),   atest = false; end
      if ~isequal(out5, ts.interval),   atest = false; end
      if ~eq(out7, ts.hist),            atest = false; end
      if ~isequal(out8, ts.name),       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 the get method of the timespan class.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Test that the get throws an error if the input are more than
    % one TIMESPAN object.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      ts  = timespan('2008-08-08 12:00:00', '2008-08-08 13:00:00');
      out = get([ts, ts], 'name');
      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_04

end