Home > classes > @tsdata > set.m

set

PURPOSE ^

SET a tsdata property.

SYNOPSIS ^

function ts = set(ts, varargin)

DESCRIPTION ^

 SET a tsdata property.

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

 DESCRIPTION: SET a tsdata property.

 CALL: ts = set(ts, 'name',    'my_name');
       ts = set(ts, 'fs',       fs);
       ts = set(ts, 't',        t);
       ts = set(ts, 'x',        x);
       ts = set(ts, 'nsecs',    nsecs);
       ts = set(ts, 't0',      '0000-00-00 00:00:00');
       ts = set(ts, 'xunits',  'Time');
       ts = set(ts, 'yunits',  'Volts');
       ts = set(ts, 'created', '0000-00-00 00:00:00');
       ts = set(ts, 'version', 'tsdata/set.m,v 1.7...');

 VERSION: $Id: set.html,v 1.1 2007/06/08 14:15:09 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 a tsdata property.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET a tsdata property.
0007 %
0008 % CALL: ts = set(ts, 'name',    'my_name');
0009 %       ts = set(ts, 'fs',       fs);
0010 %       ts = set(ts, 't',        t);
0011 %       ts = set(ts, 'x',        x);
0012 %       ts = set(ts, 'nsecs',    nsecs);
0013 %       ts = set(ts, 't0',      '0000-00-00 00:00:00');
0014 %       ts = set(ts, 'xunits',  'Time');
0015 %       ts = set(ts, 'yunits',  'Volts');
0016 %       ts = set(ts, 'created', '0000-00-00 00:00:00');
0017 %       ts = set(ts, 'version', 'tsdata/set.m,v 1.7...');
0018 %
0019 % VERSION: $Id: set.html,v 1.1 2007/06/08 14:15:09 hewitson Exp $
0020 %
0021 % HISTORY: 30-01-07 M Hewitson
0022 %             Creation
0023 %
0024 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0025 
0026 if (nargout ~= 0)
0027 
0028   propArgin = varargin;
0029 
0030   while length(propArgin) >= 2
0031     prop = propArgin{1};
0032     val  = propArgin{2};
0033     propArgin = propArgin(3:end);
0034     switch prop
0035       case 'name'
0036         ts.name = val;
0037       case 'created'
0038         ts.created = val;
0039       case 'version'
0040         ts.version = val;
0041       case 't'
0042         ts.t = val;
0043       case 'x'
0044         ts.x = val;
0045       case 'fs'
0046         ts.fs = val;
0047       case 'nsecs'
0048         ts.nsecs = val;
0049       case 'xunits'
0050         ts.xunits = val;
0051       case 'yunits'
0052         ts.yunits = val;
0053       case 't0'
0054         ts.t0 = val;
0055       otherwise
0056         error([val, ' is not a property of tsdata class']);
0057     end
0058   end
0059 
0060 else
0061   if ischar(varargin{2})
0062     error(sprintf ('### please use: %s = set(%s, ''%s'', ''%s'');', ...
0063                         inputname(1), ...
0064                         inputname(1), ...
0065                         varargin{1},  ...
0066                         varargin{2}));
0067   elseif isnumeric(varargin{2})
0068     error(sprintf ('### please use: %s = set(%s, ''%s'', %d);', ...
0069                         inputname(1), ...
0070                         inputname(1), ...
0071                         varargin{1},  ...
0072                         varargin{2}));
0073   else
0074     error(sprintf ('### please use: %s = set(%s, ''key'', ''value'');', ...
0075                         inputname(1), ...
0076                         inputname(1)));
0077   end
0078 end

Generated on Fri 08-Jun-2007 16:09:11 by m2html © 2003