ProcessIndicator.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 ProcessIndicator
  :public handle {
    public:

        logical UseWaitbar = false;
    private:

        total;

        p;

        wb;

        title;

        cur;

    
    public:

        ProcessIndicator(char title,double total,logical wb,varargin) {
            if nargin < 3
                wb = false;
            end
            if ~isempty(varargin)
                this.title= sprintf(title,varargin[:]);
            else
                this.title= sprintf(" %s (%d total) ",title,total);
            end
            this.UseWaitbar= wb;
            if nargin > 1
                this.start(total);
            end
        }
        function  start(double total) {
            if isempty(total) || ~isscalar(total) || total <= 0
                error(" Total must be a positve scalar value ");
            end
            this.total= total;
            this.cur= 0;
            this.p= 0;
            if this.UseWaitbar
                this.wb= waitbar(0,this.title," Visible "," off ");
                /*  Place at main monitor middle */
                mpos = get(0," MonitorPositions ");
                if size(mpos,1) > 1
                    npos = get(this.wb," Position ");
                    npos(1) = (mpos(1,3)/2-npos(3));
                    set(this.wb," Position ",npos);
                end
                set(this.wb," Visible "," on ");
            else
                fprintf(" %s:  ",this.title);
            end
        }
        function  set(value) {
            if nargin == 1
                error(" Set requires a value to set. ");
            end
            if value > this.total
                value = this.total;
            elseif value < 0
                value = 0;
            end
            this.cur= value;
            this.update;
        }
        function  step(double value) {
            if nargin == 1
                value = 1;
            end
            if value + this.cur > this.total
                value = this.total - this.cur;
            elseif value < -this.cur
                value = -this.cur;
            end
            this.cur= this.cur + value;
            this.update;
        }
        function  stop() {
            if this.UseWaitbar
                if ~isempty(this.wb) && ishandle(this.wb)
                    close(this.wb);
                end
            else
                fprintf(" done!\n ");
            end
        }
#if 0 //mtoc++: 'set.UseWaitbar'
function  UseWaitbar(value) {
            if ~islogical(value) || ~isscalar(value)
                error(" UseWaitbar must be a logical scalar ");
            end
            this.UseWaitbar= value;
        }

#endif

    
    private:

        function  update() {
            perc = this.cur/this.total;
            pstr = sprintf(" %2.0f%%  ",round(perc*100));
            if this.UseWaitbar
                waitbar(perc,this.wb,sprintf(" %s: %s ",this.title,pstr));
            else
                if perc > this.p
                    fprintf(" %s ",pstr);
                    this.p= ceil(perc*10)/10;
                end
            end
        }

    
};