Home > classes > @plist > set.m

set

PURPOSE ^

SET set parameter list properties.

SYNOPSIS ^

function pl = set(pl, varargin)

DESCRIPTION ^

 SET set parameter list properties.

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

 DESCRIPTION: SET set parameter list properties.

 CALL:        pl = set(pl, 'name',    'my name');
              pl = set(pl, 'params',   p);
              pl = set(pl, 'version', 'plist/set.m,v 1.7...');
              pl = set(pl, 'created',  time-object);

 REMARK:      To add a new key/value pair use the function: pset.

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

 HISTORY:     30-01-07 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function pl = set(pl, varargin)
0002 % SET set parameter list properties.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET set parameter list properties.
0007 %
0008 % CALL:        pl = set(pl, 'name',    'my name');
0009 %              pl = set(pl, 'params',   p);
0010 %              pl = set(pl, 'version', 'plist/set.m,v 1.7...');
0011 %              pl = set(pl, 'created',  time-object);
0012 %
0013 % REMARK:      To add a new key/value pair use the function: pset.
0014 %
0015 % VERSION:     $Id: set.html,v 1.14 2008/03/31 10:27:42 hewitson Exp $
0016 %
0017 % HISTORY:     30-01-07 M Hewitson
0018 %                 Creation
0019 %
0020 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0021 
0022 VERSION       = '$Id: set.html,v 1.14 2008/03/31 10:27:42 hewitson Exp $';
0023 CATEGORY      = 'Helper';
0024 DEFAULT_PLIST =  plist('name',    '',      ...
0025                        'params',  [],      ...
0026                        'plist',   plist(), ...
0027                        'version', '',      ...
0028                        'created', time());
0029 
0030 pl = generic_set(pl, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0031 
0032 if (nargout == 0)
0033   display(pl);
0034   error('\n### No output variable!\n### Please use: %s = set(%s, ''key'', ''value'');', inputname(1), inputname(1));
0035 end

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