Mercurial > hg > ltpda
diff m-toolbox/classes/@ao/xunits.m @ 0:f0afece42f48
Import.
author | Daniele Nicolodi <nicolodi@science.unitn.it> |
---|---|
date | Wed, 23 Nov 2011 19:22:13 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/classes/@ao/xunits.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,100 @@ +% XUNITS Get the data property 'xunits'. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: Get the data property 'xunits'. +% +% CALL: val = xunits(a1,a2,a3,...) +% val = xunits(as) +% val = as.xunits() +% +% INPUTS: aN - input analysis objects (tsdata, fsdata, xydata or xyzdata) +% as - input analysis objects array (tsdata, fsdata, xydata or xyzdata) +% +% OUTPUTS: val - array of with 'xunits', one for each input +% +% <a href="matlab:utils.helper.displayMethodInfo('ao', 'xunits')">Parameters Description</a> +% +% VERSION: $Id: xunits.m,v 1.12 2011/04/08 08:56:12 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = xunits(varargin) + + %%% Check if this is a call for parameters + if utils.helper.isinfocall(varargin{:}) + varargout{1} = getInfo(varargin{3}); + return + end + + import utils.const.* + property = 'xunits'; + + % Check if the method was called by another method + callerIsMethod = utils.helper.callerIsMethod; + + if ~callerIsMethod + % Collect all AOs + as = utils.helper.collect_objects(varargin(:), 'ao'); + else + % Assume the input is a single AO or a vector of AOs + as = varargin{1}; + end + + % Extract the property + for jj = 1:numel(as) + if isprop(as(jj).data, property) + out(jj) = as(jj).data.(property); + else + utils.helper.msg(msg.IMPORTANT, 'The %dth object has no %s property. Setting result to empty unit', jj, property); + out(jj) = unit(); + end + end + + % Set output + if nargout == numel(as) + % List of outputs + for ii = 1:numel(as) + varargout{ii} = out(ii); + end + else + % Single output + varargout{1} = out; + 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: xunits.m,v 1.12 2011/04/08 08:56:12 hewitson Exp $', sets, pl); + ii.setModifier(false); +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.EMPTY_PLIST; +end +