Home > classes > @tsdata > set.m

set

PURPOSE ^

SET sets a tsdata property.

SYNOPSIS ^

function ts = set(ts, varargin)

DESCRIPTION ^

 SET sets a tsdata property.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: SET sets a tsdata property.

 CALL: ts = set(ts, 'name',    'my_name');
       ts = set(ts, 'fs',       fs);
       ts = set(ts, 'x',        x);
       ts = set(ts, 'y',        y);
       ts = set(ts, 'nsecs',    nsecs);
       ts = set(ts, 't0',       Matlab serial date number);
       ts = set(ts, 'xunits',  'Time');
       ts = set(ts, 'yunits',  'Volts');
       ts = set(ts, 'created',  time());
       ts = set(ts, 'version', 'tsdata/set.m,v 1.7...');

 VERSION: $Id: set.html,v 1.14 2008/03/31 10:27:36 hewitson Exp $

 HISTORY: 30-01-07 M Hewitson
             Creation

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function ts = set(ts, varargin)
0002 % SET sets a tsdata property.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET sets a tsdata property.
0007 %
0008 % CALL: ts = set(ts, 'name',    'my_name');
0009 %       ts = set(ts, 'fs',       fs);
0010 %       ts = set(ts, 'x',        x);
0011 %       ts = set(ts, 'y',        y);
0012 %       ts = set(ts, 'nsecs',    nsecs);
0013 %       ts = set(ts, 't0',       Matlab serial date number);
0014 %       ts = set(ts, 'xunits',  'Time');
0015 %       ts = set(ts, 'yunits',  'Volts');
0016 %       ts = set(ts, 'created',  time());
0017 %       ts = set(ts, 'version', 'tsdata/set.m,v 1.7...');
0018 %
0019 % VERSION: $Id: set.html,v 1.14 2008/03/31 10:27:36 hewitson Exp $
0020 %
0021 % HISTORY: 30-01-07 M Hewitson
0022 %             Creation
0023 %
0024 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0025 
0026 VERSION       = '$Id: set.html,v 1.14 2008/03/31 10:27:36 hewitson Exp $';
0027 CATEGORY      = 'Helper';
0028 DEFAULT_PLIST =  plist('name',    '',     ...
0029                        'x',       [],     ...
0030                        'y',       [],     ...
0031                        'fs',       1,     ...
0032                        'xunits',  '',     ...
0033                        'yunits',  '',     ...
0034                        'nsecs',   '',     ...
0035                        't0',      time(), ...
0036                        'version', '',     ...
0037                        'created', time());
0038 
0039 
0040 ts = generic_set(ts, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0041 
0042 %%% plausibility check: The t0 property must be a time-object
0043 if isa(ts, 'tsdata') && ~isa(ts(1).t0, 'time')
0044   if ischar(ts(1).t0) || isnumeric(ts(1).t0)
0045     for ii=numel(ts)
0046       val = ts(ii).t0;
0047       ts(ii).t0 = time(val);
0048     end
0049   else
0050     error('### The property t0 must be a time-object or a string or a number!');
0051   end
0052 end
0053 
0054 if (nargout == 0)
0055   display(ts);
0056   error('\n### No output variable!\n### Please use: %s = set(%s, ''key'', ''value'');', inputname(1), inputname(1));
0057 end
0058

Generated on Mon 31-Mar-2008 12:20:24 by m2html © 2003