--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/testing/utp_1.1/utps/ao/utp_ao_xunits.m	Tue Dec 06 18:42:11 2011 +0100
@@ -0,0 +1,471 @@
+% UTP_AO_XUNITS a set of UTPs for the ao/xunits method
+%
+% M Hewitson 06-08-08
+%
+% $Id: utp_ao_xunits.m,v 1.5 2011/04/05 04:29:44 mauro Exp $
+%
+
+% <MethodDescription>
+%
+% The xunits method of the ao class is a get-function to get the xunits values
+% of the data object
+%
+% </MethodDescription>
+
+function results = utp_ao_xunits(varargin)
+
+  % Check the inputs
+  if nargin == 0
+
+    % Some keywords
+    class   = 'ao';
+    mthd    = 'xunits';
+
+    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 xunits method works with a vector of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_02
+
+    % <SyntaxDescription>
+    %
+    % Tests that the xunits method works with a vector of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      avec = [at1 at2 at5 at6];
+      % Vector output
+      out  = xunits(avec);
+      % List output
+      [out1, out2, out3, out4] = xunits(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.xunits), atest = false; end
+      end
+      % List output
+      if ~eq(out1, avec(1).data.xunits), atest = false; end
+      if ~eq(out2, avec(2).data.xunits), atest = false; end
+      if ~eq(out3, avec(3).data.xunits), atest = false; end
+      if ~eq(out4, avec(4).data.xunits), 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 xunits method works with a matrix of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_03
+
+    % <SyntaxDescription>
+    %
+    % Tests that the xunits method works with a matrix of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      amat = [at1 at5 at6; at5 at6 at1];
+      % Vector output
+      out  = xunits(amat);
+      % List output
+      [out1, out2, out3, out4, out5, out6] = xunits(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.xunits), atest = false; end
+      end
+      % List output
+      if ~eq(out1, amat(1).data.xunits), atest = false; end
+      if ~eq(out2, amat(2).data.xunits), atest = false; end
+      if ~eq(out3, amat(3).data.xunits), atest = false; end
+      if ~eq(out4, amat(4).data.xunits), atest = false; end
+      if ~eq(out5, amat(5).data.xunits), atest = false; end
+      if ~eq(out6, amat(6).data.xunits), 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 xunits method works with a list of AOs as input.
+  %
+  % </TestDescription>
+  function result = utp_04
+
+    % <SyntaxDescription>
+    %
+    % Tests that the xunits method works with a list of AOs as input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % Vector output
+      out  = xunits(at3, at4, at5, at6);
+      % List output
+      [out1, out2, out3, out4] = xunits(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.xunits), atest = false; end
+      if ~eq(out(2), unit()), atest = false; end
+      if ~eq(out(3), at5.data.xunits), atest = false; end
+      if ~eq(out(4), at6.data.xunits), atest = false; end
+      % List output
+      if ~eq(out1, at3.data.xunits), atest = false; end
+      if ~eq(out2, unit()), atest = false; end
+      if ~eq(out3, at5.data.xunits), atest = false; end
+      if ~eq(out4, at6.data.xunits), 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 xunits method works with a mix of different shaped AOs as
+  % input.
+  %
+  % </TestDescription>
+  function result = utp_05
+
+    % <SyntaxDescription>
+    %
+    % Tests that the xunits method works with a mix of different shaped AOs as
+    % input.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      % Vector output
+      out  = xunits(at1,[at4 at6],at5,[at5 at1; at6 at1],at6);
+      % List output
+      [out1, out2, out3, out4, out5, out6, out7, out8, out9] = ...
+        xunits(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.xunits), atest = false; end
+      if ~eq(out(2), unit()), atest = false; end
+      if ~eq(out(3), at6.data.xunits), atest = false; end
+      if ~eq(out(4), at5.data.xunits), atest = false; end
+      if ~eq(out(5), at5.data.xunits), atest = false; end
+      if ~eq(out(6), at6.data.xunits), atest = false; end
+      if ~eq(out(7), at1.data.xunits), atest = false; end
+      if ~eq(out(8), at1.data.xunits), atest = false; end
+      if ~eq(out(9), at6.data.xunits), atest = false; end
+      % List output
+      if ~eq(out1, at1.data.xunits), atest = false; end
+      if ~eq(out2, unit()), atest = false; end
+      if ~eq(out3, at6.data.xunits), atest = false; end
+      if ~eq(out4, at5.data.xunits), atest = false; end
+      if ~eq(out5, at5.data.xunits), atest = false; end
+      if ~eq(out6, at6.data.xunits), atest = false; end
+      if ~eq(out7, at1.data.xunits), atest = false; end
+      if ~eq(out8, at1.data.xunits), atest = false; end
+      if ~eq(out9, at6.data.xunits), 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 xunits method properly applies history.
+  %
+  % </TestDescription>
+  function result = utp_06
+
+    % <SyntaxDescription>
+    %
+    % The xunits 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 xunits method works for AOs with different data objects.
+  %
+  % </TestDescription>
+  function result = utp_07
+
+    % <SyntaxDescription>
+    %
+    % Test that the xunits method returns the xunits values for AOs with fsdata, 
+    % tsdata and xydata objects, and empty units for AOs with cdata.
+    %
+    % </SyntaxDescription>
+
+    try
+      % <SyntaxCode>
+      u1 = at1.xunits;
+      u2 = at2.xunits;
+      u3 = at3.xunits;
+      u4 = at4.xunits;
+      % </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.xunits), atest = false; end;
+      if ~eq(u2, at2.data.xunits), atest = false; end;
+      if ~eq(u3, at3.data.xunits), atest = false; end;
+      if ~eq(u4, unit()), 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