Home > classes > @history > set.m

set

PURPOSE ^

SET set a history property.

SYNOPSIS ^

function h = set(h, varargin)

DESCRIPTION ^

 SET set a history property.

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

 DESCRIPTION: SET set a history property.

 CALL: h = set(h, 'name',    'name');
       h = set(h, 'inhist',   history);
       h = set(h, 'invars',   {});
       h = set(h, 'plist',    plist);
       h = set(h, 'n',        n);
       h = set(h, 'pn',       pn);
       h = set(H, 'created',  time());
       h = set(h, 'version', 'history/set.m,v 1.7...');
       h = set(h, 'consver', 'history/set.m,v 1.7...');

 VERSION: $Id: set.m,v 1.11 2008/02/12 15:20:32 ingo Exp $

 HISTORY: 30-01-07 M Hewitson
             Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function h = set(h, varargin)
0002 % SET set a history property.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET set a history property.
0007 %
0008 % CALL: h = set(h, 'name',    'name');
0009 %       h = set(h, 'inhist',   history);
0010 %       h = set(h, 'invars',   {});
0011 %       h = set(h, 'plist',    plist);
0012 %       h = set(h, 'n',        n);
0013 %       h = set(h, 'pn',       pn);
0014 %       h = set(H, 'created',  time());
0015 %       h = set(h, 'version', 'history/set.m,v 1.7...');
0016 %       h = set(h, 'consver', 'history/set.m,v 1.7...');
0017 %
0018 % VERSION: $Id: set.m,v 1.11 2008/02/12 15:20:32 ingo Exp $
0019 %
0020 % HISTORY: 30-01-07 M Hewitson
0021 %             Creation
0022 %
0023 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0024 
0025 VERSION  = '$Id: set.m,v 1.11 2008/02/12 15:20:32 ingo Exp $';
0026 CATEGORY      = 'Helper';
0027 DEFAULT_PLIST =  plist('name',    '',      ...
0028                        'version', '',      ...
0029                        'plist',   plist(), ...
0030                        'inhists', [],      ...
0031                        'invars',  {},      ...
0032                        'n',       -1,      ...
0033                        'pn',      -1,      ...
0034                        'created', time(),  ...
0035                        'consver', '');
0036 
0037 h = generic_set(h, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0038 
0039 if (nargout == 0)
0040   display(h);
0041   error('\n### No output variable!\n### Please use: %s = set(%s, ''key'', ''value'');', inputname(1), inputname(1));
0042 end

Generated on Mon 31-Mar-2008 13:54:54 by m2html © 2003