Home > classes > @provenance > char.m

char

PURPOSE ^

CHAR convert a provenance object into a string.

SYNOPSIS ^

function varargout = char(varargin)

DESCRIPTION ^

 CHAR convert a provenance object into a string.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 DESCRIPTION: CHAR convert a provenance object into a string.

 CALL:        string = char(prov)

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

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

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

 HISTORY:     04-02-2007 M Hewitson
                 Creation

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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SUBFUNCTIONS ^

SOURCE CODE ^

0001 % CHAR convert a provenance object into a string.
0002 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0003 %
0004 % DESCRIPTION: CHAR convert a provenance object into a string.
0005 %
0006 % CALL:        string = char(prov)
0007 %
0008 % M-FILE INFO: Get information about this methods by calling
0009 %              >> provenance.getInfo('char')
0010 %
0011 %              Get information about a specified set-plist by calling:
0012 %              >> provenance.getInfo('char', 'set')
0013 %
0014 % VERSION:     $Id: char.m,v 1.10 2008/09/04 15:29:31 ingo Exp $
0015 %
0016 % HISTORY:     04-02-2007 M Hewitson
0017 %                 Creation
0018 %
0019 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0020 
0021 function varargout = char(varargin)
0022 
0023   % Check if this is a call for parameters
0024   if utils.helper.isinfocall(varargin{:})
0025     varargout{1} = getInfo(varargin{3});
0026     return
0027   end
0028 
0029   objs = utils.helper.collect_objects(varargin(:), 'provenance');
0030 
0031   pstr = '';
0032   for ii = 1:numel(objs)
0033     if ~isempty(pstr)
0034       pstr = [pstr ' | '];
0035     end
0036 
0037     pstr = [pstr sprintf('created by %s@%s[%s] on %s/%s/%s', ...
0038       objs(ii).creator,...
0039       objs(ii).hostname,...
0040       objs(ii).ip,...
0041       objs(ii).os,...
0042       objs(ii).matlab_version,...
0043       objs(ii).ltpda_version)];
0044   end
0045 
0046   %%% Prepare output
0047   varargout{1} = pstr;
0048 end
0049 
0050 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0051 %                               Local Functions                               %
0052 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0053 
0054 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0055 %
0056 % FUNCTION:    getInfo
0057 %
0058 % DESCRIPTION: Get Info Object
0059 %
0060 % HISTORY:     11-07-07 M Hewitson
0061 %                Creation.
0062 %
0063 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0064 
0065 function ii = getInfo(varargin)
0066   if nargin == 1 && strcmpi(varargin{1}, 'None')
0067     sets = {};
0068     pl   = [];
0069   else
0070     sets = {'Default'};
0071     pl   = getDefaultPlist;
0072   end
0073   % Build info object
0074   ii = minfo(mfilename, 'provenance', '', utils.const.categories.output, '$Id: char.m,v 1.10 2008/09/04 15:29:31 ingo Exp $', sets, pl);
0075 end
0076 
0077 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0078 %
0079 % FUNCTION:    getDefaultPlist
0080 %
0081 % DESCRIPTION: Get Default Plist
0082 %
0083 % HISTORY:     11-07-07 M Hewitson
0084 %                Creation.
0085 %
0086 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
0087 
0088 function plo = getDefaultPlist()
0089   plo = plist();
0090 end
0091

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