Timerwaitbar.m

%% TIMER WAITBAR
%  Version : v1.02
%  Author  : E. Ogier
% Updates : Corentin Wicht
%  Release : 28th mar. 2016
%
%  VERSIONS
%  - v1.0  (15th mar 2016): intial version
%  - v1.01 (28th mar 2016): modification of 'delete' method to delete the current waitbar if the last iteration is not reached
%  - v1.02 (12th nov 2018): modification of figure size, inclusion of an
%  additional "File name" input in update function 
%
%  USAGE
%  - TWB = Timerwaitbar(ITERATIONS); Creation of a Timerwaitbar for ITERATIONS loops
%  - TWB.update();                   Timerwaitbar update when a loop is performed
%  - STATUS = TWB.isinterrupted();   Timerwaitbar status ([false]/true if cancelation)
%  - TWB.delete();                   Timerwaitbar destruction
%
%  DESCRIPTION OF TIMER WAITBAR FIELDS
%  - WIP: Work In Progress [%]
%  - ETR: Estimated Time Remaining  [HH:MM:SS] if ETR < 24h | [d'd' HH:MM:SS] if ETR >= 24h
%  - ETA: Estimated Time of Arrival [HH:MM:SS] if today)    | [ddd HH:MM]     if later
%
%  EXAMPLE
%  % Number of iterations
%  N = 50;
%  
%  % Creation of a timer waitbar object
%  TWB = Timerwaitbar(N);
%  
%  % Loop
%  for n = 1:N
%      
%      % Simulation of a task 
%      pause(1);   
%       
%      % Timer waitbar update
%      TWB.update();
%      
%      % Loop break if manual cancelation
%      if TWB.isinterrupted()
%          break
%      end
%      
%  end
%  
%  % Object deletion
%  TWB.delete();

classdef Timerwaitbar < hgsetget
   
    % Properties (private access)
    properties (Access = 'private')
        Interruption    = false; % Interruption status
        Iterations      = 0;     % Number of iterations to perform
        Waitbar         = [];    % Waitbar object
        Counter         = 0;     % Iteration counter
        InitialTime     = 0;     % First iteration time
        InitialTimeDays = 0;     % First iteration time in whole days
    end
    
    % Methods
    methods
        
        % Constructor
        function [Object, NameOfFiles] = Timerwaitbar(Iterations,NameOfFiles)
             
            Object.Iterations = Iterations;
            Object.Counter    = 0;
        end
        
        % Function 'isinterrupted' (cancelation status)
        function Status = isinterrupted(Object)
            
            Status = Object.Interruption;            
            
        end
        
        % Function 'update' (waitbar update)
        function Object = update(Object,NameOfFiles)
                                    
            % NameOfFiles is optional 
            if nargin<2
                NameOfFiles = 'Computing requested files';
            end  
            % Time initialization
            if Object.Counter == 0
               Date = clock;
               Object.InitialTime = Date;               
               Object.InitialTimeDays = floor(datenum(Date));
            end
            
            % Waitbar creation
            if isempty(Object.Waitbar)
                Object.Waitbar = waitbar(0,'','Name','Progression',...
                    'CreateCancelBtn','setappdata(gcbf,''canceling'',1)');
                setappdata(Object.Waitbar,'canceling',0);
            end
            
            % Changes size
            set(findall(Object.Waitbar),'Units', 'normalized');
            % Find screen dimensions
            set(0,'units','pixels')
            ScreenDimensions=get(0,'ScreenSize');
            % Change the size of the figure
            Width=500;
            Height=300;
            set(Object.Waitbar, 'Units', 'Pixels', 'Position',...
                [ScreenDimensions(3)/2-Width/2 ScreenDimensions(4)/2-Height/2 Width Height]);
                        
            % Iterations counter increment
            Object.Counter = Object.Counter+1;
            
            % Progression
            p = Object.Counter/Object.Iterations;
                      
            % Elapsed time from first iteration
            dt = etime(clock,Object.InitialTime);
            
            % Estimations
            ETR = (1/p-1)*dt/86400;   % Estimated time remaining  [day]
            ETA = datenum(clock)+ETR; % Estimated time of arrival [day]
            
            % ETR string
            if ETR < 1
                ETRstring = datestr(ETR,'HH:MM:SS');    % ETR <  1day
            else
                ETRstring = datestr(ETR,'dd HH:MM:SS'); % ETR >= 1day
                ETRstring = strrep(ETRstring,' ','d ');
            end
            
            % ETA string
            if floor(ETA) == Object.InitialTimeDays
                ETAstring = datestr(ETA,'HH:MM:SS PM');  % ETA : today
            else
                ETAstring = datestr(ETA,'ddd HH:MM PM'); % ETA : later
            end
            
            % Progress bar update (WIP | ETR | ETA)
            waitbar(p,Object.Waitbar,...
                {NameOfFiles sprintf('\n Work In Progress: %.1f%%\n Estimated Time Remaining : %s\n Estimated Time of Arrival: %s\n',100*p,ETRstring,ETAstring)});
            
            % Interruption status
            Object.Interruption = getappdata(Object.Waitbar,'canceling');
            
            % Waitbar deletion (ending or cancelation)
            if p == 1 || Object.Interruption
                delete(Object.Waitbar);
            end
            
        end
        
        % Function 'delete'
        function Object = delete(Object)
            if ~isempty(Object.Waitbar)
                delete(Object.Waitbar);  
            end
            Object = [];
        end
        
    end
    
end