--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/classes/@ao/setZ.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,107 @@
+% SETZ sets the 'z' property of the ao.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: SETZ sets the 'z' property of the ao.
+%
+% CALL:        objs.setZ(val);
+%              objs.setZ(val1, val2);
+%              objs.setZ(plist('z', val));
+%              objs = objs.setZ(val);
+%
+% INPUTS:      objs: Can be a vector, matrix, list, or a mix of them.
+%              val:
+%                 1. Single vector e.g. [1 2 3]
+%                      Each AO in objs get this value.
+%                 2. Single vector in a cell-array e.g. {[1 2 3]}
+%                      Each AO in objs get this value.
+%                 3. cell-array with the same number of vectors as in objs
+%                    e.g. {[6 5 4], 5, [1 2 3]} and 3 AOs in objs
+%                      Each AO in objs get its corresponding value from the
+%                      cell-array
+%
+% <a href="matlab:utils.helper.displayMethodInfo('ao', 'setZ')">Parameters Description</a>
+%
+% VERSION:     $Id: setZ.m,v 1.22 2011/09/16 05:03:21 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = setZ(varargin)
+  
+  % Check if this is a call from a class method
+  callerIsMethod = utils.helper.callerIsMethod;
+  
+  if callerIsMethod
+    in_names = {};
+  else
+    % Collect input variable names
+    in_names = cell(size(varargin));
+    for ii = 1:nargin,in_names{ii} = inputname(ii);end
+  end
+  
+  objects = setPropertyValue(...
+    varargin{:}, ...
+    in_names, ...
+    callerIsMethod, ...
+    'z', ...
+    @setterFcn, ...
+    nargout, ...
+    @getInfo);
+  
+  % set outputs
+  varargout = utils.helper.setoutputs(nargout, objects);
+  
+end
+
+% Setter function to set z
+function value = setterFcn(varargin)
+  
+  if nargin < 3
+    error('Please provide a value for the ''z'' property');
+  end
+  
+  obj   = varargin{1};
+  pl    = varargin{2};
+  value = varargin{3};
+  
+  % be careful that the returned value remains an AO!
+  if isa(value, 'ao')
+    obj.data.setY(value.y);
+  else
+    obj.data.setY(value);
+  end
+  
+end
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%                               Local Functions                               %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%--------------------------------------------------------------------------
+% Get Info Object
+%--------------------------------------------------------------------------
+function ii = getInfo(varargin)
+  
+  if nargin == 1 && strcmpi(varargin{1}, 'None')
+    sets = {};
+    pl   = [];
+  else
+    sets = {'Default'};
+    pl   = getDefaultPlist();
+  end
+  % Build info object
+  ii = minfo(mfilename, 'ao', 'ltpda', utils.const.categories.helper, '$Id: setZ.m,v 1.22 2011/09/16 05:03:21 hewitson Exp $', sets, pl);
+end
+
+%--------------------------------------------------------------------------
+% Get Default Plist
+%--------------------------------------------------------------------------
+function plout = getDefaultPlist()
+  persistent pl;
+  if ~exist('pl', 'var') || isempty(pl)
+    pl = buildplist();
+  end
+  plout = pl;
+end
+
+function pl = buildplist()
+  pl = plist({'z', 'A vector to set to the z field.'}, paramValue.EMPTY_DOUBLE);
+end
+