diff m-toolbox/classes/@plist/isparam.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/@plist/isparam.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,92 @@
+% ISPARAM look for a given key in the parameter lists.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: ISPARAM look for a given key in the parameter lists. Exist the key
+%              in the parameter list then is the result 1 otherwise 0.
+%              The output size have the same numer as the numer of the input
+%              plists.
+%
+% CALL:        res = isparam(pl, 'key')
+%              res = isparam(pl1, pl2, 'key')
+%
+% <a href="matlab:utils.helper.displayMethodInfo('plist', 'isparam')">Parameters Description</a>
+%
+% VERSION:     $Id: isparam.m,v 1.16 2011/04/08 08:56:21 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = isparam(varargin)
+
+  %%% Check if this is a call for parameters
+  if utils.helper.isinfocall(varargin{:})
+    varargout{1} = getInfo(varargin{3});
+    return
+  end
+
+  [objs, invars, rest] = utils.helper.collect_objects(varargin(:), 'plist');
+
+  %%%%%%%%%%   Some plausibility checks   %%%%%%%%%%
+  if numel(rest) ~= 1
+    error('### Please specify only one ''key''.');
+  end
+
+  if ~ischar(rest{1})
+    error('### The ''key'' must be a string but it is from the class %s.', class(rest{1}));
+  end
+
+  res = zeros(size(objs));
+  key = rest{1};
+
+  for ii = 1:numel(objs)
+
+    pl = objs(ii);
+
+    for jj = 1:length(pl.params)
+      if strcmpi(pl.params(jj).key, key)
+        res(ii) = 1;
+        break
+      end
+    end
+  end
+
+  varargout{1} = res;
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%                               Local Functions                               %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getInfo
+%
+% DESCRIPTION: 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, 'plist', 'ltpda', utils.const.categories.helper, '$Id: isparam.m,v 1.16 2011/04/08 08:56:21 hewitson Exp $', sets, pl);
+  ii.setModifier(false);
+  ii.setArgsmin(1);
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getDefaultPlist
+%
+% DESCRIPTION: Get Default Plist
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function plo = getDefaultPlist()
+  plo = plist();
+end
+