% UTP_AO_YUNITS a set of UTPs for the ao/yunits method
%
% M Hewitson 06-08-08
%
% $Id: utp_ao_yunits.m,v 1.5 2011/04/05 04:29:44 mauro Exp $
%

% <MethodDescription>
%
% The yunits method of the ao class is a get-function to get the yunits values
% of the data object
%
% </MethodDescription>

function results = utp_ao_yunits(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'ao';
    mthd    = 'yunits';

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

    % Test AOs
    [at1,at2,at3,at4,at5,at6,atvec,atmat] = eval(['get_test_objects_' class]);

    % 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 all data objects

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

    % <SyntaxDescription>
    %
    % Tests that the yunits method works with a vector of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      avec = [at1 at2 at5 at6];
      % Vector output
      out  = yunits(avec);
      % List output
      [out1, out2, out3, out4] = yunits(avec);
      % </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 the input.
    % 2) Check that each output unit object contains the correct values.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(avec), atest = false; end
      % Check we have the correct values in the outputs
      % Vector output
      for kk = 1:numel(out)
        if ~eq(out(kk), avec(kk).data.yunits), atest = false; end
      end
      % List output
      if ~eq(out1, avec(1).data.yunits), atest = false; end
      if ~eq(out2, avec(2).data.yunits), atest = false; end
      if ~eq(out3, avec(3).data.yunits), atest = false; end
      if ~eq(out4, avec(4).data.yunits), 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 yunits method works with a matrix of AOs as input.
  %
  % </TestDescription>
  function result = utp_03

    % <SyntaxDescription>
    %
    % Tests that the yunits method works with a matrix of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      amat = [at1 at5 at6; at5 at6 at1];
      % Vector output
      out  = yunits(amat);
      % List output
      [out1, out2, out3, out4, out5, out6] = yunits(amat);
      % </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 the input.
    % 2) Check that each output unit object contains the correct values.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= numel(amat), atest = false; end
      % Check we have the correct values in the outputs
      % Vector output
      for kk = 1:numel(out)
        if ~eq(out(kk), amat(kk).data.yunits), atest = false; end
      end
      % List output
      if ~eq(out1, amat(1).data.yunits), atest = false; end
      if ~eq(out2, amat(2).data.yunits), atest = false; end
      if ~eq(out3, amat(3).data.yunits), atest = false; end
      if ~eq(out4, amat(4).data.yunits), atest = false; end
      if ~eq(out5, amat(5).data.yunits), atest = false; end
      if ~eq(out6, amat(6).data.yunits), 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 yunits method works with a list of AOs as input.
  %
  % </TestDescription>
  function result = utp_04

    % <SyntaxDescription>
    %
    % Tests that the yunits method works with a list of AOs as input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Vector output
      out  = yunits(at3, at4, at5, at6);
      % List output
      [out1, out2, out3, out4] = yunits(at3, at4, at5, at6);
      % </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 the input.
    % 2) Check that each output unit object contains the correct values.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 4, atest = false; end
      % Check we have the correct values in the outputs
      % Vector output
      if ~eq(out(1), at3.data.yunits), atest = false; end
      if ~eq(out1, at3.data.yunits), atest = false; end
      if ~eq(out(2), at4.data.yunits), atest = false; end
      if ~eq(out2, at4.data.yunits), atest = false; end
      % List output
      if ~eq(out(3), at5.data.yunits), atest = false; end
      if ~eq(out3, at5.data.yunits), atest = false; end
      if ~eq(out(4), at6.data.yunits), atest = false; end
      if ~eq(out4, at6.data.yunits), 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 yunits method works with a mix of different shaped AOs as
  % input.
  %
  % </TestDescription>
  function result = utp_05

    % <SyntaxDescription>
    %
    % Tests that the yunits method works with a mix of different shaped AOs as
    % input.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % Vector output
      out  = yunits(at1,[at4 at6],at5,[at5 at1; at6 at1],at6);
      % List output
      [out1, out2, out3, out4, out5, out6, out7, out8, out9] = ...
        yunits(at1,[at4 at6],at5,[at5 at1; at6 at1],at6);
      % </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 the input.
    % 2) Check that each output unit object contains the correct values.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(out) ~= 9, atest = false; end
      % Check we have the correct values in the outputs
      % Vector output
      if ~eq(out(1), at1.data.yunits), atest = false; end
      if ~eq(out(2), at4.data.yunits), atest = false; end
      if ~eq(out(3), at6.data.yunits), atest = false; end
      if ~eq(out(4), at5.data.yunits), atest = false; end
      if ~eq(out(5), at5.data.yunits), atest = false; end
      if ~eq(out(6), at6.data.yunits), atest = false; end
      if ~eq(out(7), at1.data.yunits), atest = false; end
      if ~eq(out(8), at1.data.yunits), atest = false; end
      if ~eq(out(9), at6.data.yunits), atest = false; end
      % List output
      if ~eq(out1, at1.data.yunits), atest = false; end
      if ~eq(out2, at4.data.yunits), atest = false; end
      if ~eq(out3, at6.data.yunits), atest = false; end
      if ~eq(out4, at5.data.yunits), atest = false; end
      if ~eq(out5, at5.data.yunits), atest = false; end
      if ~eq(out6, at6.data.yunits), atest = false; end
      if ~eq(out7, at1.data.yunits), atest = false; end
      if ~eq(out8, at1.data.yunits), atest = false; end
      if ~eq(out9, at6.data.yunits), atest = false; 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 yunits method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The yunits method doesn't change the AO, 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>
  %
  % Tests that the yunits method works for AOs with different data objects.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the yunits method returns the yunits values for AOs with cdata,
    % fsdata, tsdata and xydata objects.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      at4.setYunits('Hz s^-1');
      u1 = at1.yunits;
      u2 = at2.yunits;
      u3 = at3.yunits;
      u4 = at4.yunits;
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

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

    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(u1, at1.data.yunits), atest = false; end;
      if ~eq(u2, at2.data.yunits), atest = false; end;
      if ~eq(u3, at3.data.yunits), atest = false; end;
      if ~eq(u4, at4.data.yunits), atest = false; end;
      % </AlgoCode>
    else
      atest = false;
    end

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

end
