view m-toolbox/classes/@smodel/setXvar.m @ 12:86aabb42dd84
database-connection-manager
Use utils.repository utilities
author
Daniele Nicolodi <nicolodi@science.unitn.it>
date
Mon, 05 Dec 2011 16:20:06 +0100 (2011-12-05)
parents
f0afece42f48
children
line source
+ − % SETXVAR sets the 'xvar' property of the smodel object.
+ − %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+ − %
+ − % DESCRIPTION: SETXVAR sets the 'xvar' property of the smodel object.
+ − %
+ − % CALL: objs.setXvar(val);
+ − % objs.setXvar(val1, val2);
+ − % objs.setXvar(plist('xvar', val));
+ − % objs = objs.setXvar(val);
+ − %
+ − % INPUTS: objs: Can be a vector, matrix, list, or a mix of them.
+ − % val: Can be any of the following types:
+ − % - string e.g. 'x1'
+ − % - plist with the key 'xvar' e.g. plist('xvar', {'x1', 'x2'})
+ − % - cell-array with the types above
+ − %
+ − % REMARK: The x-variable defines later the type of the data object.
+ − % 't': AO with time-series data
+ − % 'f': AO with frequency-series data
+ − % 'w': AO with frequency-series data
+ − % all other: AO with xy data
+ − %
+ − % <a href="matlab:utils.helper.displayMethodInfo('smodel', 'setXvar')">Parameters Description</a>
+ − %
+ − % VERSION: $Id: setXvar.m,v 1.12 2011/08/16 06:06:05 hewitson Exp $
+ − %
+ − %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+ −
+ − function varargout = setXvar(varargin)
+ −
+ − % Check if this is a call from a class method
+ − callerIsMethod = utils.helper.callerIsMethod;
+ −
+ − if callerIsMethod
+ − sm = varargin{1};
+ − values = processValues({}, varargin(2:end));
+ −
+ − else
+ − % Check if this is a call for parameters
+ − if utils.helper.isinfocall(varargin{:})
+ − varargout{1} = getInfo(varargin{3});
+ − return
+ − end
+ −
+ − import utils.const.*
+ − utils.helper.msg(msg.PROC3, 'running %s/%s', mfilename('class'), mfilename);
+ −
+ − % Collect input variable names
+ − in_names = cell(size(varargin));
+ − for ii = 1:nargin,in_names{ii} = inputname(ii);end
+ −
+ − % Collect all smodel objects
+ − [sm, sm_invars, rest] = utils.helper.collect_objects(varargin(:), 'smodel', in_names);
+ − pls = utils.helper.collect_objects(rest(:), 'plist');
+ −
+ − % Combine input plists and default PLIST
+ − pls = combine(pls, getDefaultPlist());
+ −
+ − % Get values for the smodel objects
+ − values = processValues({}, rest);
+ −
+ − end % callerIsMethod
+ −
+ − % Decide on a deep copy or a modify
+ − sm = copy(sm, nargout);
+ −
+ − % Loop over smodel objects
+ − for jj = 1:numel(sm)
+ − sm(jj).xvar = values;
+ − if ~callerIsMethod
+ − plh = pls.pset('xvar', values);
+ − sm(jj).addHistory(getInfo('None'), plh, sm_invars(jj), sm(jj).hist);
+ − end
+ − end
+ −
+ − % Set output
+ − varargout = utils.helper.setoutputs(nargout, sm);
+ − end
+ −
+ − %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+ − % Local Functions %
+ − %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+ −
+ − function values = processValues(values, rest)
+ − if ~isempty(rest)
+ − switch class(rest)
+ − case 'cell'
+ − if iscellstr(rest)
+ − values = [values rest];
+ − else
+ − for ii = 1:numel(rest);
+ − values = processValues(values, rest{ii});
+ − end
+ − end
+ − case 'char'
+ − values = [values {rest}];
+ − case 'plist'
+ − if length(rest) == 1 && isa(rest, 'plist') && isparam(rest, 'xvar')
+ − vals = find(rest, 'xvar');
+ − values = processValues(values, vals);
+ − end
+ − otherwise
+ − end
+ − end
+ − end
+ −
+ − %--------------------------------------------------------------------------
+ − % 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, mfilename('class'), 'ltpda', utils.const.categories.helper, '$Id: setXvar.m,v 1.12 2011/08/16 06:06:05 hewitson Exp $', sets, pl);
+ − 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({'xvar', 'Specify the X-dependent variable in the model.'}, paramValue.EMPTY_CELL);
+ − end