SolverFeatureSet.m

classdef SolverFeatureSet < handle
    % An auxiliary class to specify the features supported by a solver.
    %
    % Copyright (c) 2012-2026, Imperial College London
    % All rights reserved.
    
    properties
        list; % list of features
    end
    
    properties (Constant)
        fields = {'ClassSwitch',...
            'Cache', ...
            'Delay', ...
            'DelayStation',...
            'Fork',...
            'Join',...
            'Logger',...
            'Place', ...
            'Queue', ...
            'Sink',...
            'Source',...
            'Router',...
            'Transition', ...
            'Cox2',...
            'APH',...
            'Det', ...
            'Erlang',...
            'Exp',...
            'Gamma',...
            'HyperExp', ...
            'Lognormal',...
            'MAP',...
            'MMPP2',...
            'Normal',...
            'Pareto',...
            'PH',...
            'Replayer',...
            'Trace',...
            'Uniform', ...
            'Weibull',...
            'StatelessClassSwitcher',...
            'CacheClassSwitcher',...
            'InfiniteServer',...
            'Forker',...
            'Joiner',...
            'LogTunnel', ...
            'SharedServer', ...
            'Buffer', ...
            'Linkage',...
            'Enabling', ...
            'Timing', ...
            'Firing', ...
            'Storage', ...
            'Timing', ...
            'RandomSource', ...
            'Dispatcher', ...
            'Server', ...
            'ServiceTunnel', ...
            'RoutingStrategy_PROB', ...
            'RoutingStrategy_RAND', ...
            'RoutingStrategy_RROBIN', ...
            'RoutingStrategy_WRROBIN', ...
            'RoutingStrategy_KCHOICES', ...
            'SchedStrategy_INF', ...
            'SchedStrategy_FCFS', ...
            'SchedStrategy_LCFS', ...
            'SchedStrategy_LCFSPI', ...
            'SchedStrategy_LCFSPR', ...
            'SchedStrategy_SEPT', ...
            'SchedStrategy_LEPT', ...
            'SchedStrategy_DPS', ...
            'SchedStrategy_GPS', ...
            'SchedStrategy_LJF', ...
            'SchedStrategy_LPS', ...
            'SchedStrategy_SJF', ...
            'SchedStrategy_SRPT', ...
            'SchedStrategy_SRPTPRIO', ...
            'SchedStrategy_PS', ...
            'SchedStrategy_SIRO', ...
            'SchedStrategy_HOL', ...
            'SchedStrategy_EXT', ...
            'SchedStrategy_POLLING', ...
            'ReplacementStrategy_RR', ...
            'ReplacementStrategy_FIFO', ...
            'ReplacementStrategy_SFIFO', ...
            'ReplacementStrategy_LRU', ...
            'ClosedClass', ...
            'OpenClass'};
    end
    
    methods
        function self = SolverFeatureSet()
            % SELF = SOLVERFEATURESET()
            
            % Nodes and Stations
            fields = SolverFeatureSet.fields;
            for f=1:length(fields)
                self.list.(fields{f})=false;
            end
        end
        
        function self = setTrue(self, feature)
            % SELF = SETTRUE(FEATURE)
            
            if iscell(feature)
                for c=1:length(feature)
                    self.setTrue(feature{c});
                end
            else
                if ~strcmpi(feature,'char') % ignore empty sections
                    self.list.(feature) = true;
                end
            end
        end
        
        function self = setFalse(self, feature)
            % SELF = SETFALSE(FEATURE)
            
            if iscell(feature)
                for c=1:length(feature)
                    self.setFalse(feature{c});
                end
            else
                self.list.(feature) = false;
            end
        end
        
    end
    
    methods(Static)
        function bool = supports(featSupportedList, featUsedList)
            % BOOL = SUPPORTS(FEATSUPPORTEDLIST, FEATUSEDLIST)
            
            bool = true;
            unsupported = {};
            
            % Nodes and Stations
            fields = SolverFeatureSet.fields;
            for f=1:length(fields)
                if featUsedList.list.(fields{f}) > featSupportedList.list.(fields{f})
                    bool = false;                    
                    unsupported{end+1} = fields{f}; %#ok<AGROW>
                end
            end
            
            if ~isempty(unsupported)
                str='Some features are not supported by the chosen solver (feature: ';
                for u=1:length(unsupported)
                    if u==1
                        str = sprintf('%s%s',str,unsupported{u});
                    else
                        str = sprintf('%s, %s',str,unsupported{u});
                    end
                end
                str = sprintf('%s).\n',str);
                line_warning(mfilename,str);
            end
        end
    end
end