ExecutionReport.m

classdef ExecutionReport < handle
    %EXECUTIONREPORT Summary of this class goes here
    %   Detailed explanation goes here
    
    properties
        %% General
        sys = [];           % Original model 
        loc = [];           % Model path, used to crate a backup model here
        shortname = 'n/a';  % Combine shortname from configs
        
        id;                 % Combines sys with shortname
        
        configs;            % utility.cell of ExecConfig
        
        last_ok;            % Last ExecStatus field which completed without errors
        
        %% Execution Related (prior to comparison)
        
        exception;          % Exceptions (utility.cell)
        
        preexec_file = [];  % Freshly created pre-execution file
        
        %% Comparison Related
        
        simdata;            % Simulation result (raw form)
        
        covdata;            % Coverage data, if collected
        
        refined;            % Simulation result (refined)
        
        %% CF Stats
        
        % total logged signals in this execution
        num_signals = [];           
        
        % my signals which were also found in comparison base signal. aka
        % Intersection of mine and base
        num_found_signals  = 0;     
        
        % Base's signals not found in me. i.e signals which only exist in
        % base aka base.num_signals - obj.num_found_signals
        num_missing_in_base = 0;    
    end
    
    
    methods
        function obj = ExecutionReport()
            %%
            obj.exception = utility.cell();
            obj.configs = utility.cell();
            obj.last_ok = difftest.ExecStatus.Idle;
            
        end
        
        function ret = create_copy(obj, config)
            %% Only used during cartesian product calculation.
            % Does not copy all attributes
            ret = difftest.ExecutionReport();
            
            % Copy attributes
            ret.configs = obj.configs.deep_copy();
            
            if ~isempty(config)
                ret.configs.add(config);
            end
            
        end
        
        function ret = is_ok(obj, exec_status)
            %%
            % If exec_status is not passed, checks absense of execption
            % i.e. whether the last operation passed successfully.
            if nargin >=2
                ret = uint32(obj.last_ok) >= uint32(exec_status);
                return;
            end
            
            ret = obj.exception.len == 0;
        end
        
        function simargs = get_sim_args(obj)
            %%
            [simargs, snames] = difftest.get_sim_config(obj.configs);
            
            obj.shortname = strjoin(snames.get_cell(), '_');
            obj.id = [obj.sys ' ::config:: ' obj.shortname];
            
        end
        
        function validate_input(obj)
            %%
            assert(~isempty(obj.loc));
            assert(~isempty(obj.sys));
            assert(obj.configs.len > 0);
        end
        
        function ret = get_report(obj)
            %% Prepares report to store in disc.
            % Currently creates large files if include the following
            % ignored fields
            ret = utility.get_struct_from_object(obj, containers.Map(...
                {'simdata', 'refined'}, {1, 1}));
        end
        
        function throw_comp_error(obj)
            if ~ obj.is_ok()
                throw(MException('RandGen:SL:CompareErrorGeneric', ...
                    'One or more errors during comparison'));
            end
        end
        
        function ret = get_exception_messages(obj)
            ret = cellfun(@(p)p.message, obj.exception.get_cell_T(),...
                'UniformOutput', false);
        end
        
        function print_exception_messages(obj, l)
            emsgs = obj.get_exception_messages();
            for i=1:numel(emsgs)
                l.warn(emsgs{i});
            end
        end
        
    end
    
end