Home > classes > @mfir > set.m

set

PURPOSE ^

SET set a mfir object property.

SYNOPSIS ^

function f = set(f, varargin)

DESCRIPTION ^

 SET set a mfir object property.

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

 DESCRIPTION: SET set an mfir object property.

 CALL:        f    = set(f, property, value);
              mfir = set(mfir, 'name',    'name');
              mfir = set(mfir, 'fs',       0);
              mfir = set(mfir, 'ntaps',    0);
              mfir = set(mfir, 'a',        []);
              mfir = set(mfir, 'gd',       0);
              mfir = set(mfir, 'gain',        0);
              mfir = set(mfir, 'histout',  history());
              mfir = set(mfir, 'infile',   'name');
              mfir = set(mfir, 'plist',    plist);
              mfir = set(mfir, 'created',  time());
              mfir = set(mfir, 'version', 'version');

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

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