Mercurial > hg > ltpda
diff m-toolbox/classes/@ao/setT0.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/@ao/setT0.m Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,106 @@ +% SETT0 sets the 't0' property of the ao. +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% +% DESCRIPTION: SETT0 sets the 't0' property of the ao. +% +% CALL: objs.setT0(val); +% objs.setT0(val1, val2); +% objs.setT0(plist('t0', val)); +% objs = objs.setT0(val); +% +% INPUTS: objs: Can be a vector, matrix, list, or a mix of them. +% val: A time-string or number +% 1. Single value e.g. '14:00:00' +% Each AO in objs get this value. +% 2. Single value in a cell-array e.g. {4} +% Each AO in objs get this value. +% 3. cell-array with the same number of values as in objs +% e.g. {'14:00:00, 5, '15:00:00'} and 3 AOs in objs +% Each AO in objs get its corresponding value from the +% cell-array +% +% <a href="matlab:utils.helper.displayMethodInfo('ao', 'setT0')">Parameters Description</a> +% +% VERSION: $Id: setT0.m,v 1.25 2011/09/16 05:03:21 hewitson Exp $ +% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +function varargout = setT0(varargin) + + % Check if this is a call from a class method + callerIsMethod = utils.helper.callerIsMethod; + + if callerIsMethod + in_names = {}; + else + % Collect input variable names + in_names = cell(size(varargin)); + for ii = 1:nargin,in_names{ii} = inputname(ii);end + end + + objects = setPropertyValue(... + varargin{:}, ... + in_names, ... + callerIsMethod, ... + 't0', ... + @setterFcn, ... + nargout, ... + @getInfo); + + % set outputs + varargout = utils.helper.setoutputs(nargout, objects); + +end + +% Setter function to set the t0 +function value = setterFcn(varargin) + + if nargin < 3 + error('Please provide a value for the ''t0'' property'); + end + + obj = varargin{1}; + pl = varargin{2}; + value = varargin{3}; + + obj.data.setT0(value); + +end + + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +% Local Functions % +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%-------------------------------------------------------------------------- +% 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, 'ao', 'ltpda', utils.const.categories.helper, '$Id: setT0.m,v 1.25 2011/09/16 05:03:21 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({'t0', ['The time to set.<br>' ... + 'You can enter the t0 as a string or as a number. If you want to enter a number please enter this number and convert the type with a right click on the number to a double.']}, ... + {1, {'14:00:00 10-10-2009'}, paramValue.OPTIONAL}); +end