Home > classes > @pz > setF.m

setF

PURPOSE ^

SETF Set the property 'f'

SYNOPSIS ^

function ii = setF(ii, val)

DESCRIPTION ^

 SETF Set the property 'f'
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: SETF Set the property 'f' and computes 'ri'

 CALL:        obj = obj.setF(1);
              obj = setF(obj, 1);

 INPUTS:      obj - is a pz object

 VERSION:     $Id: setF.m,v 1.1 2008/07/11 17:34:47 ingo Exp $

 HISTORY:     27-05-2008 Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % SETF Set the property 'f'
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: SETF Set the property 'f' and computes 'ri'
0005 %
0006 % CALL:        obj = obj.setF(1);
0007 %              obj = setF(obj, 1);
0008 %
0009 % INPUTS:      obj - is a pz object
0010 %
0011 % VERSION:     $Id: setF.m,v 1.1 2008/07/11 17:34:47 ingo Exp $
0012 %
0013 % HISTORY:     27-05-2008 Hewitson
0014 %                 Creation
0015 %
0016 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0017 
0018 function ii = setF(ii, val)
0019 
0020   %%% decide whether we modify the pz-object, or create a new one.
0021   ii = copy(ii, nargout);
0022 
0023   %%% set 'f'
0024   ii.f = val;
0025   %%% Then compute and set ri
0026   ii.ri = pz.fq2ri(ii.f, ii.q);
0027 end

Generated on Mon 08-Sep-2008 13:18:47 by m2html © 2003