% UTP_MFIR_SETOUNITS a set of UTPs for the mfir/setOunits method
%
% M Hewitson 06-08-08
%
% $Id: utp_mfir_setOunits.m,v 1.7 2011/04/19 18:14:01 ingo Exp $
%

% <MethodDescription>
%
% The setOunits method of the mfir class sets the ounits property.
%
% </MethodDescription>

function results = utp_mfir_setOunits(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'mfir';
    mthd    = 'setOunits';

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

    % Test MFIR objects
    [firhp,firlp,firbp,firbr,firpzm,firao,firv,firm] = get_test_objects_mfir;

    % 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];    % Set the property with a plist
    results = [results utp_09];    % Test output of the data

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

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

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

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(firv)), atest = false; end
      % Check ounits field of each output
      for kk=1:numel(out)
        if ~eq(out(kk).ounits, unit('Hz')), 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 setOunits method works with a matrix of MFIR objects as input.
  %
  % </TestDescription>
  function result = utp_03

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

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

    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if ~isequal(size(out), size(firm)), atest = false; end
      % Check ounits field of each output
      for kk=1:numel(out)
        if ~eq(out(kk).ounits, unit('Hz')), 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 setOunits method works with a list of MFIR objects as input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out = setOunits(firhp,firpzm,firbp, unit('Hz'));
      % </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 we have the correct number of outputs
      if numel(out) ~= 3, atest = false; end
      % Check each output against the input
      if ~eq(out(1).ounits, unit('Hz')), atest = false; end
      if ~eq(out(2).ounits, unit('Hz')), atest = false; end
      if ~eq(out(3).ounits, unit('Hz')), 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 setOunits method works with a mix of different shaped MFIR
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out = setOunits(firhp,firv,firpzm,firm,firbp, unit('Hz'));
      % </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 we have the correct number of outputs
      if numel(out) ~= (3+numel(firm)+numel(firv)), atest = false; end
      for kk=1:numel(out)
        if ~eq(out(kk).ounits, unit('Hz')), 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 setOunits method properly applies history and that the
  % option 'internal' suppresses the history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % Test that the result of applying the setOunits method can be processed back
    % to an m-file.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out1 = setOunits(firhp, unit('Hz'));
      out2 = testCallerIsMethod(@setOunits, firhp, unit('Hz'));
      mout1 = rebuild(out1);
      mout2 = rebuild(out2);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the last entry in the history of 'out1' corresponds to
    %    'setOunits'.
    % 2) Check that the last entry in the history of 'out2' NOT corresponds to
    %    'setOunits'.
    % 3) Check that the 'rebuild' method produces the same object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the last step in the history of 'out1'
      if ~(strcmp(out1.hist.methodInfo.mname, 'setOunits') && ...
          eq(out1.hist.plistUsed, plist('ounits', unit('Hz')), ple1))
        atest = false;
      end
      % Check the last step in the history of 'out2'
      if eq(out2.hist.plistUsed, plist('ounits', unit('Hz')), ple1)
        atest = false;
      end
      % Check the rebuilt object
      if ~eq(mout1, out1, ple2), atest = false; end
      e = ple2.find('EXCEPTIONS');
      ple = plist('EXCEPTIONS', [e {'ounits'}]);
      if ~eq(mout2, out2, ple), atest = false; end
      % </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 setOunits method can modify the input MFIR object.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the setOunits method can modify the input MFIR object
    % by calling with no output.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy firhp to work with
      ain = mfir(firhp);
      % modify ain
      aout = ain.setOunits(unit('Hz'));
      ain.setOunits(unit('Hz'));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that 'firhp' and 'ain' are now different.
    % 2) Check that 'ain' has the correct ounits field
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check that setOunits modified the input by comparing to the copy
      if eq(mfir(firhp), ain, ple1), atest = false; end
      % Check that setOunits doesn't modified the input for the function notation
      if ~eq(aout, ain, ple1), atest = false; end
      % Check that the modified object contains the changed value
      if ~eq(ain.ounits, unit('Hz')), 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>
  %
  % Tests that the setOunits method can set the property with a plist.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the setOunits method can modify the property 'ounits'
    % with a value in a plist.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      pl  = plist('ounits', unit('Hz'));
      out = firhp.setOunits(pl);
      mout = rebuild(out);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that 'ain' has the correct ounits field
    % 2) Check that the 'rebuild' method produces the same object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the field 'ounits'
      if ~eq(out.ounits, unit('Hz')), atest = false; end
      % Check the rebuilt object
      if ~eq(mout, out, ple2), 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>
  %
  % Check that the setOunits method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_09

    % <SyntaxDescription>
    %
    % Call the method with a list of output variables and with a single output
    % variable. Additionaly check that the rebuild method works on the output.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      [o1, o2] = setOunits(firhp, firlp, unit('mol'));
      o3  = setOunits(firhp, firlp, unit('mol'));
      mout1 = rebuild(o1);
      mout2 = rebuild(o2);
      mout3 = rebuild(o3);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that the output contains the right number of objects
    % 2) Check that the 'rebuild' method produces the same object as 'out'.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      % Check the number of outputs
      if numel(o1) ~=1, atest = false; end
      if numel(o2) ~=1, atest = false; end
      if numel(o3) ~=2, atest = false; end
      % Check the rebuilding of the object
      if ~eq(o1, mout1, ple2), atest = false; end
      if ~eq(o2, mout2, ple2), atest = false; end
      if ~eq(o3, mout3, ple2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end

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

end