Home > classes > @pz > display.m

display

PURPOSE ^

DISPLAY display a pz object.

SYNOPSIS ^

function varargout = display(varargin)

DESCRIPTION ^

 DISPLAY display a pz object.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: DISPLAY a pz object.

 CALL FOR PARAMETERS:

              obj.display('INFO') % Retrieve method information

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

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

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

 HISTORY:     30-01-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % DISPLAY display a pz object.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: DISPLAY a pz object.
0005 %
0006 % CALL FOR PARAMETERS:
0007 %
0008 %              obj.display('INFO') % Retrieve method information
0009 %
0010 % M-FILE INFO: Get information about this methods by calling
0011 %              >> pz.getInfo('display')
0012 %
0013 %              Get information about a specified set-plist by calling:
0014 %              >> pz.getInfo('display', 'set')
0015 %
0016 % VERSION:     $Id: display.m,v 1.3 2008/09/04 15:29:31 ingo Exp $
0017 %
0018 % HISTORY:     30-01-2007 M Hewitson
0019 %                 Creation
0020 %
0021 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0022 
0023 function varargout = display(varargin)
0024 
0025   % Check if this is a call for parameters
0026   if utils.helper.isinfocall(varargin{:})
0027     varargout{1} = getInfo(varargin{3});
0028     return
0029   end
0030 
0031   % Get minfo objects
0032   objs = utils.helper.collect_objects(varargin(:), 'pz');
0033 
0034   % get display text
0035   txt = utils.helper.objdisp(objs);
0036 
0037   % display the objects
0038   if nargout > 0
0039     varargout{1} = txt;
0040   elseif nargout == 0;
0041     for j=1:numel(txt)
0042       disp(txt{j});
0043     end
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, 'pz', '', utils.const.categories.output, '$Id: display.m,v 1.3 2008/09/04 15:29:31 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