object2str.m

Go to the documentation of this file.

/* (Autoinserted by mtoc++)
 * This source code has been filtered by the mtoc++ executable,
 * which generates code that can be processed by the doxygen documentation tool.
 *
 * On the other hand, it can neither be interpreted by MATLAB, nor can it be compiled with a C++ compiler.
 * Except for the comments, the function bodies of your M-file functions are untouched.
 * Consequently, the FILTER_SOURCE_FILES doxygen switch (default in our Doxyfile.template) will produce
 * attached source files that are highly readable by humans.
 *
 * Additionally, links in the doxygen generated documentation to the source code of functions and class members refer to
 * the correct locations in the source code browser.
 * However, the line numbers most likely do not correspond to the line numbers in the original MATLAB source files.
 */

function str = object2str(handle obj,integer maxdepth) {


if ~isobject(obj)
    error(" The obj argument has to be a matlab object. ");
end
if nargin < 2
    maxdepth = Inf; /*  Default: Inf depth */

elseif ~isnumeric(maxdepth) || ~isreal(maxdepth)
    error(" maxdepth has to be a real value/integer. ");
end
sizelbl = [" G "," M "," k "," b "];
[str, bytes] = recursive2str(obj, maxdepth, 0, []);

    function [str, bytes] = recursive2str(obj, depth, numtabs, done)
        /*  Internal recursion. */
        str = ;
        if depth == 0
            bytes = 0;
            return;
        end
        done[end+1] = obj;
        mc = metaclass(obj);
        if isfield(obj," Name ")
            name = obj.Name;
        else
            name = mc.Name;
        end
        if ~isempty(str)
            str = [str " %s:  " name " \n "];
        else
            str = [name " %s:\n "];
        end
        /*  get string cell of names and sort alphabetically */
        names = cellfun(@(mp)mp.Name,mc.Properties," UniformOutput ",false);
        [~, sortedidx] = sort(names);
        bytes = 0; subbytes = 0;
        for n = 1:length(sortedidx)
            idx = sortedidx(n);
            p = mc.Properties[idx];
            addbytes = 0;
            if strcmp(p.GetAccess," public ")
                str = [str repmat(" \t ",1,numtabs) " . "]; /* #ok<*AGROW> */

                pobj = obj.(p.Name);
                if ~isempty(pobj) && ~any(cellfun(@(el)isequal(pobj,el),done))
                    /*  Pre-compute addbytes and only override if pobj is object itself */
                    tmp = whos(" pobj ");
                    addbytes = tmp.bytes;
                    if isobject(pobj)
                        [recstr, addbytes] = recursive2str(pobj, depth-1, numtabs+1, done);
                        subbytes = subbytes + addbytes;
                        str = [str p.Name "  -  " recstr];
                    elseif isnumeric(pobj)
                        if numel(pobj) > 20
                            sizestr = getSizeStr(addbytes);
                            if ~isempty(sizestr)
                                sizestr = ["  ( " sizestr " ) "];
                            end
                            spar = ;
                            if issparse(pobj)
                                spar = " sparse  ";
                            end
                            str = [str p.Name " : [ " num2str(size(pobj)) " ]  " spar class(pobj) sizestr];
                        else
                            pobj = reshape(pobj,1,[]);
                            str = [str p.Name " :  " num2str(pobj)];
                        end
                    elseif isstruct(pobj)
                        if any(size(pobj) > 1)
                            str = [str p.Name "  (struct, [ " num2str(size(pobj)) " ]), fields:  "];
                        else
                            str = [str p.Name "  (struct), fields:  "];
                        end
                        fn = fieldnames(pobj);
                        for fnidx = 1:length(fn)
                            str = [str fn[fnidx] " , "];
                        end
                        str = str(1:end-1);
                    elseif isa(pobj," function_handle ")
                        str = [str p.Name "  (f-handle):  " func2str(pobj)];
                    elseif ischar(pobj)
                        str = [str p.Name " :  " pobj];
                    elseif islogical(pobj)
                        if pobj
                            str = [str p.Name " : true "];
                        else
                            str = [str p.Name " : false "];
                        end
                    elseif iscell(pobj)
                        str = [str sprintf(" %s: %dx%d cell<%s> ", p.Name, size(pobj,1),size(pobj,2),class(pobj[1]))];
                    else
                        str = [str p.Name " : ATTENTION. Display for type ' " class(pobj) " ' not implemented yet. "];
                    end
                else
                    if isequal(obj,pobj)
                        str = [str p.Name " : [self-reference] "];
                    else
                        str = [str p.Name " : empty "];
                    end
                end
                str = [str " \n "];
            end
            bytes = bytes + addbytes;
        end

        /*  Take away the last \n for inner recursive calls */
        if depth < maxdepth
            str = str(1:end-2);
        end

        /*  Format!
         * Add byte information */
        if subbytes > 0
            sizestr = sprintf("  (self:%s, childs:%s, total:%s) ",...
                getSizeStr(bytes-subbytes),getSizeStr(subbytes),getSizeStr(bytes));
        else
            sizestr = sprintf("  (%s) ",getSizeStr(bytes));
        end
        str = sprintf(str,sizestr);

        function res = getSizeStr(bytes)
            hr = bytes ./ [1024^3 1024^2 1024 1];
            pos = find(hr > 1,1);
            res = ;
            if ~isempty(pos)
                res = sprintf(" %.5g%s ",hr(pos),sizelbl[pos]);
            end
        end
    end
end
}