Mercurial > hg > ltpda
diff m-toolbox/classes/@plist/setSelectionForParam.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/setSelectionForParam.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,130 @@ +% SETSELECTIONFORPARAM Sets the selection mode of the param object in dependencies of the 'key' +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: Sets the selection mode of the param object in dependencies +% of the 'key' +% +% CALL: obj = obj.setSelectionForParam('key', selection); +% obj = obj.setSelectionForParam(plist('KEY', 'key', 'SELECTION', selection)); +% obj = setSelectionForParam(obj, 'key', selection); +% +% INPUTS: obj - can be a vector, matrix, list, or a mix of them. +% key - The key which should be changed +% selection - Selection mode of the parameter +% pl - to set the default value of a key with a plist, +% please specify only one plist with the key-words +% 'key' and 'selection' +% +% POSSIBLE VALUES FOR 'selection' +% +% selection: 1 == paramValue.OPTIONAL +% 2 == paramValue.SINGLE +% 3 == paramValue.MULTI +% +% <a href="matlab:utils.helper.displayMethodInfo('plist', 'setSelectionForParam')">Parameters Description</a> +% +% VERSION: $Id: setSelectionForParam.m,v 1.6 2011/04/08 08:56:21 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +function varargout = setSelectionForParam(varargin) + + %%% Check if this is a call for parameters + if utils.helper.isinfocall(varargin{:}) + varargout{1} = getInfo(varargin{3}); + return + end + + [objs, obj_invars, rest] = utils.helper.collect_objects(varargin(:), 'plist'); + + for kk = 1:numel(objs) + pls = objs(kk); + %%% If the plist contains only two key/value pairs with the keys 'key' + %%% and 'selection' then set the slection mode with this plist. + if pls.nparams == 2 && pls.isparam('key') && pls.isparam('selection') + rest{1} = pls.find('key'); + rest{2} = pls.find('selection'); + objs(kk) = []; + break; + end + end + + if numel(rest) ~= 2 + error('### Please specify a selection mode AND a key, either in a plist or directly.'); + end + + key = rest{1}; + selection = rest{2}; + + %%% Set the Name + for ii = 1:numel(objs) + + %%% decide whether we modify the first plist, or create a new one. + objs(ii) = copy(objs(ii), nargout); + + for kk = 1:objs(ii).nparams + if strcmpi(key, objs(ii).params(kk).key) + objs(ii).params(kk).val.setSelection(selection); + end + end + end + + %%% Set output + if nargout == numel(objs) + % List of outputs + for ii = 1:numel(objs) + varargout{ii} = objs(ii); + end + else + % Single output + varargout{1} = objs; + 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: setSelectionForParam.m,v 1.6 2011/04/08 08:56:21 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 set the selection mode for.'}, paramValue.EMPTY_STRING); + pl.append(p); + + % Index + p = param({'selection', 'The selection mode to set.'}, {1, {1,2,3}, paramValue.OPTIONAL}); + pl.append(p); + +end +