% UTP_MIIR_ISPROP a set of UTPs for the miir/isprop method
%
% M Hewitson 06-08-08
%
% $Id: utp_miir_isprop.m,v 1.6 2011/03/29 13:13:33 ingo Exp $
%

% <MethodDescription>
%
% The isprop method of the miir class determine whether input is object
% property.
%
% </MethodDescription>

function results = utp_miir_isprop(varargin)

  % Check the inputs
  if nargin == 0

    % Some keywords
    class   = 'miir';
    mthd    = 'isprop';

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

    % Test MIIR objects
    [iirhp,iirlp,iirbp,iirbr,iirpzm,iirab,iirv,iirm] = get_test_objects_miir;

    % 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 negative case

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

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

    try
      % <SyntaxCode>
      out = isprop(iirv, 'name');
      % </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 'iirv'
    % 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(iirv)), atest = false; end
      % Check each output
      if ~all(out), 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 isprop method works with a matrix of MIIR objects as
  % input.
  %
  % </TestDescription>
  function result = utp_03

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

    try
      % <SyntaxCode>
      out = isprop(iirm, 'name');
      % </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 'iirm'
    % 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(iirm)), atest = false; end
      % Check each output
      if ~all(out), 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 isprop method works with a list of MIIR objects as
  % input.
  %
  % </TestDescription>
  function result = utp_04

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

    try
      % <SyntaxCode>
      out = isprop(iirlp,iirpzm,iirbr, 'name');
      % </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
      if ~all(out), 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 isprop method works with a mix of different shaped
  % MIIR objects as input.
  %
  % </TestDescription>
  function result = utp_05

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

    try
      % <SyntaxCode>
      out = isprop(iirlp,iirv,iirpzm,iirm,iirbr, 'name');
      % </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(iirm)+numel(iirv)), atest = false; end
      % Check each output
      if ~all(out), 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 isprop method properly applies history.
  %
  % </TestDescription>
  function result = utp_06

    % <SyntaxDescription>
    %
    % The method isprop doesn't change the object, thus it is not necessary
    % to apply history. 
    %
    % </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 isprop method works for each property.
  %
  % </TestDescription>
  function result = utp_07

    % <SyntaxDescription>
    %
    % Test that the isprop method works for the properties:
    % 'b', 'histin', 'ntaps', 'fs', 'infile', 'a', 'histout', 
    % 'iunits', 'ounits', 'hist', 'name'
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      % copy iirlp to work with
      out1  = isprop(iirlp, 'b');
      out2  = isprop(iirlp, 'histin');
      out4  = isprop(iirlp, 'ntaps');
      out5  = isprop(iirlp, 'fs');
      out6  = isprop(iirlp, 'infile');
      out7  = isprop(iirlp, 'a');
      out8  = isprop(iirlp, 'histout');
      out9  = isprop(iirlp, 'iunits');
      out10 = isprop(iirlp, 'ounits');
      out11 = isprop(iirlp, 'hist');
      out12 = isprop(iirlp, 'name');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that each output contains the correct data.
    %
    % </AlgoDescription>

    atest = true;
    if stest
      % <AlgoCode>
      if ~out1,  atest = false; end;
      if ~out2,  atest = false; end;
      if ~out4,  atest = false; end;
      if ~out5,  atest = false; end;
      if ~out6,  atest = false; end;
      if ~out7,  atest = false; end;
      if ~out8,  atest = false; end;
      if ~out9,  atest = false; end;
      if ~out10, atest = false; end;
      if ~out11, atest = false; end;
      if ~out12, 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 negative case and the not function command.
  %
  % </TestDescription>
  function result = utp_08

    % <SyntaxDescription>
    %
    % Test that the isprop method retrun false for a unknown property and for
    % methods of the object.
    %
    % </SyntaxDescription>

    try
      % <SyntaxCode>
      out1 = isprop(iirbp, 'foo');
      out2 = iirbp.isprop('foo');
      out3 = iirbp.isprop('name');
      out4 = iirbp.isprop('type');
      out5 = iirbp.isprop('char');
      out6 = iirbp.isprop('creator');
      out7 = iirbp.isprop('created');
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end

    % <AlgoDescription>
    %
    % 1) Check that each output contains the correct data.
    %
    % </AlgoDescription>

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