modelIntParameter.m

classdef modelIntParameter < modelParameter
    %modelIntParameter A value which controls a model option.
    %   Every parameter should be defined as an instance of this class so
    %   important information about that parameter is available.  Example
    %   parameters include output directories, evolution on/off, super
    %   symbiont options, and number of worker threads.
    
    properties
        default int32
        minimum int32
        maximum int32
        value int32
    end
    
    methods
        function p = modelIntParameter(cat, n, type, def, min, max, nullOK)
            %modelParameter Construct an instance of this class
            %   Detailed explanation goes here
            if nargin < 6
                error('Integer parameters must be defined with a category, name, type, default, min, and max.  A 7th argument may be used to indicate that null values are allowed.');
            end
            % The two parameters sent to the superclass are mostly
            % handled there.
            p@modelParameter(cat, n, type);
            if ~strcmp(type, 'integer')
                error('Integer parameters must be specified by name as integers.');
            end
            if nargin == 7
                p.nullAllowed = nullOK;
            end
            % Note that typed constants are doubles even if a whole number
            % is typed.  Instead of isinteger, check for whole numbers
            % using rem (remainder);
            if rem(def, 1) == 0 && rem(min, 1) == 0 && rem(max, 1) == 0
                p.default = def;
                p.value = def;
                p.minimum = min;
                p.maximum = max;
            else
                error('Default, min, and max must be numeric')
            end
        end
        
        
        function obj = set(obj, v)
            if obj.nullAllowed && isempty(v)
                obj.value = [];
                return;
            end
            if isfloat(v)
                if floor(v) == v
                    v = cast(v, 'int32');
                else
                    error('Value of %s must be a whole number, not %d.', obj.name, v);
                end
            end
            if isinteger(v)
                % Note that v may be an array rather than a single integer.
                if min(v) >= obj.minimum && max(v) <= obj.maximum
                    if length(v) > 1
                        % vectors may arrive as a column or row - make it
                        % consistently a row:
                        v = reshape(v, 1, []);
                    end
                    obj.value = v;
                else
                    error('Value of %s must be between %d and %d.  %d is not.', obj.name, obj.minimum, obj.maximum, v);
                end
            else
                error('You can not set an integer to a non-integer value.');
            end
        end
        
        function [v] = get(obj)
            v = obj.value;
        end
        
        function vs = asString(obj)
            if length(obj.value) == 1
                vs = num2str(obj.value);
            else
                vs = '';
                comma = '';
                for i = 1:length(obj.value)
                    vs = strcat(vs, comma, num2str(obj.value(i)));
                    comma = ',';
                end
            end
        end

    end
end