Home > classes > @mfir > display.m

display

PURPOSE ^

DISPLAY overloads display functionality for mfir objects.

SYNOPSIS ^

function varargout = display(varargin)

DESCRIPTION ^

 DISPLAY overloads display functionality for mfir objects.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: DISPLAY overloads display functionality for mfir objects.

 CALL:        txt  = display(mfir)

 INPUT:       mfir - IIR filter object

 OUTPUT:      txt  - cell array with strings to display the mfir object

 M-FILE INFO: Get information about this methods by calling
              >> mfir.getInfo('display')

              Get information about a specified set-plist by calling:
              >> mfir.getInfo('display', 'set')

 VERSION:     $Id: display.m,v 1.12 2008/09/04 15:29:30 ingo Exp $

 HISTORY:     11-01-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % DISPLAY overloads display functionality for mfir objects.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: DISPLAY overloads display functionality for mfir objects.
0005 %
0006 % CALL:        txt  = display(mfir)
0007 %
0008 % INPUT:       mfir - IIR filter object
0009 %
0010 % OUTPUT:      txt  - cell array with strings to display the mfir object
0011 %
0012 % M-FILE INFO: Get information about this methods by calling
0013 %              >> mfir.getInfo('display')
0014 %
0015 %              Get information about a specified set-plist by calling:
0016 %              >> mfir.getInfo('display', 'set')
0017 %
0018 % VERSION:     $Id: display.m,v 1.12 2008/09/04 15:29:30 ingo Exp $
0019 %
0020 % HISTORY:     11-01-2007 M Hewitson
0021 %                 Creation
0022 %
0023 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0024 
0025 function varargout = display(varargin)
0026 
0027   %%% Check if this is a call for parameters
0028   if utils.helper.isinfocall(varargin{:})
0029     varargout{1} = getInfo(varargin{3});
0030     return
0031   end
0032 
0033   objs = utils.helper.collect_objects(varargin(:), 'mfir');
0034 
0035   % get display text
0036   txt = utils.helper.objdisp(objs);
0037 
0038   if nargout == 0
0039     for ii=1:length(txt)
0040       disp(txt{ii});
0041     end
0042   else
0043     varargout{1} = txt;
0044   end
0045 end
0046 
0047 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0048 %                               Local Functions                               %
0049 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0050 
0051 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0052 %
0053 % FUNCTION:    getInfo
0054 %
0055 % DESCRIPTION: Get Info Object
0056 %
0057 % HISTORY:     11-07-07 M Hewitson
0058 %                Creation.
0059 %
0060 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0061 
0062 function ii = getInfo(varargin)
0063   if nargin == 1 && strcmpi(varargin{1}, 'None')
0064     sets = {};
0065     pl   = [];
0066   else
0067     sets = {'Default'};
0068     pl   = getDefaultPlist;
0069   end
0070   % Build info object
0071   ii = minfo(mfilename, 'mfir', '', utils.const.categories.output, '$Id: display.m,v 1.12 2008/09/04 15:29:30 ingo Exp $', sets, pl);
0072 end
0073 
0074 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0075 %
0076 % FUNCTION:    getDefaultPlist
0077 %
0078 % DESCRIPTION: Get Default Plist
0079 %
0080 % HISTORY:     11-07-07 M Hewitson
0081 %                Creation.
0082 %
0083 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0084 
0085 function plo = getDefaultPlist()
0086   plo = plist();
0087 end
0088

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