diff m-toolbox/classes/@pzmodel/display.m @ 0:f0afece42f48

Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/m-toolbox/classes/@pzmodel/display.m	Wed Nov 23 19:22:13 2011 +0100
@@ -0,0 +1,136 @@
+% DISPLAY overloads display functionality for pzmodel objects.
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% DESCRIPTION: DISPLAY overloads display functionality for pzmodel objects.
+%
+% CALL:        txt     = display(pzmodel)
+%
+% INPUT:       pzmodel - pole/zero model object
+%
+% OUTPUT:      txt     - cell array with strings to display the pole/zero model object
+%
+% <a href="matlab:utils.helper.displayMethodInfo('pzmodel', 'display')">Parameters Description</a>
+%
+% VERSION:     $Id: display.m,v 1.27 2011/04/08 08:56:32 hewitson Exp $
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function varargout = display(varargin)
+
+  %%% Check if this is a call for parameters
+  if utils.helper.isinfocall(varargin{:})
+    varargout{1} = getInfo(varargin{3});
+    return
+  end
+
+  objs = utils.helper.collect_objects(varargin(:), 'pzmodel');
+
+  txt = {};
+  
+  % Print emtpy object
+  if isempty(objs)
+    hdr = sprintf('------ %s -------', class(objs));
+    ftr(1:length(hdr)) = '-';
+    txt = [txt; {hdr}];
+    txt = [txt; sprintf('empty-object [%d,%d]',size(objs))];
+    txt = [txt; {ftr}];
+  end
+  
+  for i=1:numel(objs)
+    banner = sprintf('---- pzmodel %d ----', i);
+    txt{end+1} = banner;
+
+    % get key and value
+    name  = objs(i).name;
+    desc  = objs(i).description;
+    g     = objs(i).gain;
+    del   = objs(i).delay;
+    ps    = objs(i).poles;
+    zs    = objs(i).zeros;
+    np    = numel(ps);
+    nz    = numel(zs);
+    iunit = char(objs(i).iunits);
+    ounit = char(objs(i).ounits);
+
+    % display
+    txt{end+1} = ['       name: ' name];
+    txt{end+1} = ['       gain: ' num2str(g)];
+    txt{end+1} = ['      delay: ' num2str(del)];
+    txt{end+1} = ['     iunits: ' iunit];
+    txt{end+1} = ['     ounits: ' ounit];
+    txt{end+1} = ['description: ' desc];
+    txt{end+1} = ['       UUID: ' objs(i).UUID];
+
+    for j=1:np
+      txt{end+1} = [sprintf('pole %03d: ', j) char(ps(j)) ];
+    end
+    for j=1:nz
+      txt{end+1} = [sprintf('zero %03d: ', j) char(zs(j)) ];
+    end
+
+    banner_end(1:length(banner)) = '-';
+    txt{end+1} = banner_end;
+  end
+
+  if nargout == 0
+    for ii=1:length(txt)
+      disp(txt{ii});
+    end
+  else
+    varargout{1} = txt;
+  end
+
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%                               Local Functions                               %
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getInfo
+%
+% DESCRIPTION: Get Info Object
+%
+% HISTORY:     11-07-07 M Hewitson
+%                Creation.
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function ii = getInfo(varargin)
+  if nargin == 1 && strcmpi(varargin{1}, 'None')
+    sets = {};
+    pl   = [];
+  else
+    sets = {'Default'};
+    pl   = getDefaultPlist;
+  end
+  % Build info object
+  ii = minfo(mfilename, 'pzmodel', 'ltpda', utils.const.categories.output, '$Id: display.m,v 1.27 2011/04/08 08:56:32 hewitson Exp $', sets, pl);
+  ii.setModifier(false);
+  ii.setOutmin(0);
+end
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%
+% FUNCTION:    getDefaultPlist
+%
+% DESCRIPTION: Get Default Plist
+%
+% HISTORY:     11-07-07 M Hewitson
+%                Creation.
+%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+function plout = getDefaultPlist()
+  persistent pl;  
+  if exist('pl', 'var')==0 || isempty(pl)
+    pl = buildplist();
+  end
+  plout = pl;  
+end
+
+function pl = buildplist()
+  pl = plist.EMPTY_PLIST;
+end
+