DPCM.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.
 */

class DPCM {
    public: /* ( Constant ) */

        static const .cell PropClasses = {"'critical','important','alglimit','scaling','optional','data','experimental','verbose'"};
        static const .char PropClassesLink = "matlab:help DPCM";
    public: /* ( Static ) */ /* ( Constant ) */


        static function  getDPCMReport(DPCMobj,levels) {
            if nargin < 2
                levels = DPCM.PropClasses;
            elseif ischar(levels)
                levels = [levels];
            end
            msg = DPCM.runDPCM(DPCMobj, levels);
            DPCM.printReport(msg, levels);
        }
        static function  getDPCMSummary(DPCMobj,levels) {
            if nargin < 2
                levels = DPCM.PropClasses;
            elseif ischar(levels)
                levels = [levels];
            end
            [~, stats] = DPCM.runDPCM(DPCMobj, levels);
            DPCM.printSummary(stats, levels);
        }
        static function  criticalsCheck(DPCMobj) {
            levels = DPCM.PropClasses(1);
            [msg, stats] = DPCM.runDPCM(DPCMobj, levels);
            if stats(1,1) > 0
                if ~isempty(DPCMobj.WorkspaceVariableName)
                    link = sprintf(" <a href='matlab:DPCM.getDPCMReport(%s, "" critical "" )'>critical properties</a> ",DPCMobj.WorkspaceVariableName);
                else
                    link = " critical properties ";
                    DPCM.printReport(msg, levels);
                end
                DPCM.print(" red ",[" RESULTS QUESTIONABLE: %d of %d  " link "  are still at their default value.\n "],...
                    stats(1,1),stats(2,1));
            end
        }
    private: /* ( Static ) */ /* ( Constant ) */


        static function  printSummary(stats,levels) {
            total = sum(stats,2);
            total(3) = total(1)/total(2)*100;

            col = [total(3)/100 1-total(3)/100 0];
            DPCM.print(col," Total unchanged properties: %d of %d (%2.2f%%%%)\n ",total);
            for lidx = 1:length(levels)
                col = [stats(3,lidx)/100 1-stats(3,lidx)/100 0];
                lvidx = find(strcmp(levels[lidx],DPCM.PropClasses),1);
                DPCM.print(col, " Unchanged  "" %s "" : %d of %d (%2.2f%%%%)\n ",levels[lidx],stats(:,lvidx));
            end
        }
        static function  printReport(msg,levels) {
            for idx = 1:length(levels)
                m = msg.(levels[idx]);
                if ~isempty(m)
                    DPCM.print([.5 .5 0]," Messages for property class %s:\n ",levels[idx]);
                    fprintf(" %s\n ",m[:]);
                    fprintf(" \n ");
                end
            end
        }
        static function  print(varargin) {
            if ~isempty(which(" cprintf "))
                cprintf(varargin[:]);
            else
                fprintf(2,varargin[2:end]);
            end
        }
        static function [msg , pstats ] = runDPCM(DPCMobj,levels) {
            counts = struct;
            notchanged = struct;
            messages = struct;
            for lidx=1:length(levels)
                counts.(levels[lidx]) = 0;
                messages.(levels[lidx]) = [];
            end
            notchanged = counts;

            /* % Run recursive check */
            if isfield(DPCMobj," Name ") || isprop(DPCMobj," Name ")
                n = DPCMobj.Name;
            else
                tmp = metaclass(DPCMobj);
                n = tmp.Name;
            end
            recurCheck(DPCMobj, Dictionary, n);

            /*  Store collected messages */
            msg = messages;

            /*  Some total stats now
             *c = [struct2array(notchanged); struct2array(counts)]; */
            c = cell2mat([struct2cell(notchanged) struct2cell(counts)])^t;
            c(3,:) = round(10000 * c(1,:) ./ c(2,:))/100;
            c(3,isnan(c(3,:))) = 0;
            pstats = c;

            function recurCheck(DPCMobj, done, lvl)
                mc = metaclass(DPCMobj);
                done(DPCMobj.ID) = true;

                /* % Link name preparations */
                objlink = editLink(mc.Name);

                /* % Check the local properties */
                pc = DPCMobj.PropertiesChanged;
                for pidx = 1:length(mc.Properties)
                    p = mc.Properties[pidx];
                    if strcmp(p.GetAccess," public ") && ~p.Constant && ~p.Transient && strcmp(p.SetAccess," public ") /* ~strcmp(p.SetAccess,'private') */

                        key = [p.DefiningClass.Name " . " p.Name];
                        if pc.containsKey(key)
                            p = pc(key);
                            /*  Ignore if property level is not wanted */
                            if any(strcmp(p.Level,levels))
                                counts.(p.Level) = counts.(p.Level) + 1;
                                if ~p.Changed
                                    notchanged.(p.Level) = notchanged.(p.Level) + 1;
                                    if ~any(strcmp(p.Level," data "))
                                        hlp = messages.(p.Level);
                                        /* if strcmp(mc.Name,p.) */
                                        hlp[end+1] = sprintf(" %s is still unchanged!\nProperty brief: %s\nPropclass tag description:\n%s\n ",...
                                            [lvl " [ " objlink " ] ->  " p.Name],p.Short,p.Text);/* #ok */

                                        messages.(p.Level) = hlp;
                                    end
                                end
                            end
                        elseif ~p.SetObservable && ~pc.containsKey([p.DefiningClass.Name " . " p.Name])
/*                              link2 = editLink(p.DefiningClass.Name);
 *                             fprintf('Attention: Property %s of class %s is not <a href="matlab:docsearch SetObservable">SetObservable</a> but a candidate for a user-definable public property!\nFor more details see <a href="%s">Property classes and levels</a>\n\n',p.Name,link2,DPCM.PropClassesLink); */
                        end
                        pobj = DPCMobj.(p.Name);
                        /*  Recursively register subobject's properties */
                        if isa(pobj, " DPCMObject ") && isempty(done(pobj.ID))
                            recurCheck(pobj, done, [lvl " [ " objlink " ] ->  " p.Name]);
                        end
                    end
                end
            end

            function l = editLink(classname)
                dotpos = strfind(classname," . ");
                if ~isempty(dotpos)
                    lname = classname(dotpos(end)+1:end);
                else
                    lname = classname;
                end
                l = sprintf(" <a href='matlab:edit %s'>%s</a> ",classname,lname);
            end
        }
};