Home > classes > @pzmodel > set.m

set

PURPOSE ^

SET sets a pole/zero model property.

SYNOPSIS ^

function pzm = set(pzm, varargin)

DESCRIPTION ^

 SET sets a pole/zero model property.

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

 DESCRIPTION: SET sets a pole/zero model property.

 CALL:        pzmodel = set(pzmodel, 'name',    str);
              pzmodel = set(pzmodel, 'gain',    g);
              pzmodel = set(pzmodel, 'poles',   p);
              pzmodel = set(pzmodel, 'zeros',   z);
              pzmodel = set(pzmodel, 'created', time-object);
              pzmodel = set(pzmodel, 'version', cvs version string);

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

 HISTORY:     30-01-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 function pzm = set(pzm, varargin)
0002 % SET sets a pole/zero model property.
0003 %
0004 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0005 %
0006 % DESCRIPTION: SET sets a pole/zero model property.
0007 %
0008 % CALL:        pzmodel = set(pzmodel, 'name',    str);
0009 %              pzmodel = set(pzmodel, 'gain',    g);
0010 %              pzmodel = set(pzmodel, 'poles',   p);
0011 %              pzmodel = set(pzmodel, 'zeros',   z);
0012 %              pzmodel = set(pzmodel, 'created', time-object);
0013 %              pzmodel = set(pzmodel, 'version', cvs version string);
0014 %
0015 % VERSION:     $Id: set.html,v 1.14 2008/03/31 10:27:37 hewitson Exp $
0016 %
0017 % HISTORY:     30-01-2007 M Hewitson
0018 %                 Creation
0019 %
0020 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0021 
0022 VERSION       = '$Id: set.html,v 1.14 2008/03/31 10:27:37 hewitson Exp $';
0023 CATEGORY      = 'Helper';
0024 DEFAULT_PLIST =  plist('name',    '',      ...
0025                        'gain',     0,      ...
0026                        'poles',   pole(),  ...
0027                        'zeros',   zero(),  ...
0028                        'plist',   plist(), ...
0029                        'version', '',      ...
0030                        'created', time());
0031 
0032 pzm = generic_set(pzm, varargin, DEFAULT_PLIST, VERSION, CATEGORY);
0033 
0034 if (nargout == 0)
0035   display(pzm);
0036   error('\n### No output variable!\n### Please use: %s = set(%s, ''key'', ''value'');', inputname(1), inputname(1));
0037 end

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