Home > classes > @param > set.m

set

PURPOSE ^

SET set a parameter property.

SYNOPSIS ^

function p = set(p, varargin)

DESCRIPTION ^

 SET set a parameter property.

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

 DESCRIPTION: SET set a parameter property.

 CALL: p = set(p, 'key',     'name');
       p = set(p, 'val',      val);
       p = set(p, 'val',     'val');
       p = set(p, 'name',    'my name');
       p = set(p, 'created',  time-object);

 VERSION: $Id: set.m,v 1.9 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 p = set(p, varargin)
0002 % SET set a parameter property.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET set a parameter property.
0007 %
0008 % CALL: p = set(p, 'key',     'name');
0009 %       p = set(p, 'val',      val);
0010 %       p = set(p, 'val',     'val');
0011 %       p = set(p, 'name',    'my name');
0012 %       p = set(p, 'created',  time-object);
0013 %
0014 % VERSION: $Id: set.m,v 1.9 2008/02/12 15:20:32 ingo Exp $
0015 %
0016 % HISTORY: 30-01-07 M Hewitson
0017 %             Creation
0018 %
0019 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0020 
0021 VERSION       = '$Id: set.m,v 1.9 2008/02/12 15:20:32 ingo Exp $';
0022 CATEGORY      = 'Helper';
0023 DEFAULT_PLIST =  plist('name',    '', ...
0024                        'key',     '', ...
0025                        'val',     [], ...
0026                        'created', time, ...
0027                        'version', '');
0028 
0029 p = generic_set(p, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0030 
0031 %%% plausibility check: The KEY property must be a string!
0032 if isa(p, 'param') && ~ischar(p(1).key)
0033   error('### The key must be a string!');
0034 end
0035 
0036 if (nargout == 0)
0037   display(p);
0038   error('\n### No output variable!\n### Please use: %s = set(%s, ''key'', ''value'');', inputname(1), inputname(1));
0039 end

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