Home > classes > @miir > set.m

set

PURPOSE ^

SET set a miir object property.

SYNOPSIS ^

function f = set(f, varargin)

DESCRIPTION ^

 SET set a miir object property.

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

 DESCRIPTION: SET set a miir object property.

 CALL:        miir = set(miir, property,  value);
              miir = set(miir, 'name',    'name');
              miir = set(miir, 'fs',      0);
              miir = set(miir, 'ntaps',   0);
              miir = set(miir, 'a',       []);
              miir = set(miir, 'b',       []);
              miir = set(miir, 'gain',    0);
              miir = set(miir, 'histin',  history());
              miir = set(miir, 'histout', history());
              miir = set(miir, 'infile',  'name');
              miir = set(miir, 'plist',   plist());
              miir = set(miir, 'created',  time());
              miir = set(miir, 'version', '$Date: 2008/02/13 18:33:19 $');

 VERSION:     $Id: set.m,v 1.10 2008/02/13 18:33:19 ingo Exp $

 HISTORY:     30-01-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function f = set(f, varargin)
0002 % SET set a miir object property.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET set a miir object property.
0007 %
0008 % CALL:        miir = set(miir, property,  value);
0009 %              miir = set(miir, 'name',    'name');
0010 %              miir = set(miir, 'fs',      0);
0011 %              miir = set(miir, 'ntaps',   0);
0012 %              miir = set(miir, 'a',       []);
0013 %              miir = set(miir, 'b',       []);
0014 %              miir = set(miir, 'gain',    0);
0015 %              miir = set(miir, 'histin',  history());
0016 %              miir = set(miir, 'histout', history());
0017 %              miir = set(miir, 'infile',  'name');
0018 %              miir = set(miir, 'plist',   plist());
0019 %              miir = set(miir, 'created',  time());
0020 %              miir = set(miir, 'version', '$Date: 2008/02/13 18:33:19 $');
0021 %
0022 % VERSION:     $Id: set.m,v 1.10 2008/02/13 18:33:19 ingo Exp $
0023 %
0024 % HISTORY:     30-01-2007 M Hewitson
0025 %                 Creation
0026 %
0027 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0028 
0029 VERSION       = '$Id: set.m,v 1.10 2008/02/13 18:33:19 ingo Exp $';
0030 CATEGORY      = 'Helper';
0031 DEFAULT_PLIST =  plist('name',    '',      ...
0032                        'fs',      0,       ...
0033                        'ntaps',   0,       ...
0034                        'a',       [],      ...
0035                        'b',       [],      ...
0036                        'gain',    0,       ...
0037                        'histin',  [],      ...
0038                        'histout', [],      ...
0039                        'infile',  '',      ...
0040                        'plist',   plist(), ...
0041                        'created', time(),  ...
0042                        'version', '');
0043 
0044 f = generic_set(f, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0045 
0046 if (nargout == 0)
0047   display(f);
0048   error('\n### No output variable!\n### Please use: %s = set(%s, ''key'', ''value'');', inputname(1), inputname(1));
0049 end

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