diff m-toolbox/classes/@plist/find.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/find.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,125 @@
+% FIND overloads find routine for a parameter list.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: FIND overloads find routine for a parameter list.
+%              Returns the value corresponding to the first parameter in
+%              the list with the search-key.
+%              An optional argument can be passed so it is assigned to the
+%              return in case the search-key was not found.
+%
+% CALL:        a = find(pl, 'key')
+%              a = find(pl, pl)
+%              a = find(pl, 'key', opt_val)
+%              a = find(pl, pl, opt_val)
+%
+% 
+% EXAMPLES:
+% 
+% 1)  a = pl.find('foo') % get the parameter with key 'foo'
+% 2)  a = pl.find(plist('key', 'WIN')) % get the parameter with key 'WIN'
+% 3)  a = pl.find('foo', 1) % get the parameter with key 'foo', and get 1
+%                           if the key was not present in the input plist
+% 
+% <a href="matlab:utils.helper.displayMethodInfo('plist', 'find')">Parameters Description</a>
+%
+% VERSION:     $Id: find.m,v 1.25 2011/04/08 08:56:21 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = find(varargin)
+
+  %%% Check if this is a call for parameters
+  if utils.helper.isinfocall(varargin{:})
+    varargout{1} = getInfo(varargin{3});
+    return
+  end
+
+  if nargin > 3 && nargin < 2
+    error('### Incorrect inputs')
+  end
+
+  pl  = varargin{1};
+  if isa(varargin{2}, 'plist')
+    key = varargin{2}.find('key');
+  else
+    key = varargin{2};
+  end
+  def_val = [];
+  if nargin == 3
+    def_val = varargin{3};    
+  end
+
+  %%%%%%%%%%   Some plausibility checks   %%%%%%%%%%
+  if numel(pl) ~= 1
+    error('### This function could only work with one plist-object');
+  end
+
+  if ~ischar(key)
+    error('### The ''key'' must be a string but it is from the class %s.', class(key));
+  end
+
+  if ~isempty(pl.params)
+    dkeys = {pl.params(:).key};
+  else
+    dkeys = {''};
+  end
+
+  % Get value we want
+  matches = strcmpi(key, dkeys);
+  if any(matches)
+    val = pl.params(matches).getVal;
+  else
+    val = def_val;
+  end
+
+  if isa(val, 'ltpda_obj')
+    varargout{1} = copy(val, 1);
+  else
+    varargout{1} = val;
+  end
+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: find.m,v 1.25 2011/04/08 08:56:21 hewitson Exp $', sets, pl);
+  ii.setModifier(false);
+  ii.setArgsmin(1);
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getDefaultPlist
+%
+% DESCRIPTION: Get Default Plist
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function pl = getDefaultPlist()
+  
+  pl = plist();
+  
+  % Key
+  p = param({'key', 'A key to search for.'}, paramValue.EMPTY_STRING);
+  pl.append(p);  
+  
+end
+