--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/classes/@plist/getDescriptionForParam.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,99 @@
+% GETDESCRIPTIONFORPARAM Returns the description for the specified parameter key.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: GETDESCRIPTIONFORPARAM Returns the description for the
+%              specified parameter key.
+%
+% CALL:        obj = obj.getDescriptionForParam('key');
+%              obj = obj.getDescriptionForParam(plist('key'));
+%              obj = getDescriptionForParam(obj, 'key');
+%
+% INPUTS:      obj - can be a vector, matrix, list, or a mix of them.
+%              key - Parameter key
+%
+% <a href="matlab:utils.helper.displayMethodInfo('plist', 'getDescriptionForParam')">Parameters Description</a>
+% 
+% VERSION:     $Id: getDescriptionForParam.m,v 1.6 2011/04/08 08:56:20 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = getDescriptionForParam(varargin)
+  
+  %%% Check if this is a call for parameters
+  if utils.helper.isinfocall(varargin{:})
+    varargout{1} = getInfo(varargin{3});
+    return
+  end
+  
+  if nargin ~= 2
+    error('### This method works only with two inputs (plist + key name).');
+  end
+  if ~(isa(varargin{1}, 'plist') || numel(varargin{1} ~= 1))
+    error('### This method accepts only one plist as an input.')
+  end
+  if ~(ischar(varargin{2}) || isa(varargin{2}, 'plist'))
+    error('### The second input must be a ')
+  end
+  
+  pl  = varargin{1};
+  key = varargin{2};
+  val = '';
+  
+  if isa(key, 'plist')
+    key = key.find('key');
+  end
+  
+  for ii = 1:pl.nparams
+    if strcmpi(pl.params(ii).key, key)
+      val = pl.params(ii).desc;
+      break;
+    end
+  end
+  
+  % Single output
+  varargout{1} = val;
+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.internal, '$Id: getDescriptionForParam.m,v 1.6 2011/04/08 08:56:20 hewitson Exp $', sets, pl);
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getDefaultPlist
+%
+% DESCRIPTION: Get Default Plist
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function pl = getDefaultPlist()
+  
+  pl = plist();
+  
+  % Key
+  p = param({'key', 'The key of the parameter to get the description of.'}, paramValue.EMPTY_STRING);
+  pl.append(p);  
+  
+end
+