pstructLH.m

%% PstructLH
%{
Structure describing a potentially calibrated parameter

valueV
   default values; used when not calibrated
doCal
   can take on any value; can determine under what condition a parameter is calibrated

%}

classdef pstructLH < handle

properties
   name        % name, such as prefBeta
   symbolStr   % symbol used in paper
   descrStr    % Long description used in param tables
   valueV      % default values if not calibrated
   % bounds if calibrated
   %  scalars are expanded to size of valueV
   lbV         
   ubV
   doCal       % is it calibrated?
end
   
methods      
   %% Constructor
   function p = pstructLH(nameStr, symbolStr, descrStr, valueV, lbV, ubV, doCal)
      p.name = nameStr;
      p.symbolStr = symbolStr;
      p.descrStr = descrStr;
      p.valueV = valueV;
      %p.lbV = lbV;
      %p.ubV = ubV;
      p.doCal = doCal;
      p.set_bounds(lbV, ubV);
      validate(p);
   end

   %% Update with new data
   function update(p, valueV, lbV, ubV, doCal)
      if ~isempty(valueV)
         p.valueV = valueV;
      end
      if ~isempty(doCal)
         p.doCal = doCal;
      end
      p.set_bounds(lbV, ubV);
      validate(p);
   end
   
   %% Set bounds with scalar expansion
   function set_bounds(p, lbV, ubV)
      if ~isempty(lbV)
         if length(lbV) == 1  &&  length(p.valueV) > 1
            p.lbV = repmat(lbV, size(p.valueV));
         else
            p.lbV = lbV;
         end
      end
      if ~isempty(ubV)
         if length(ubV) == 1  &&  length(p.valueV) > 1
            p.ubV = repmat(ubV, size(p.valueV));
         else
            p.ubV = ubV;
         end
      end     
   end
      
   
   %% Validate values in struct
   function validate(p)
   %    if ~any(p.doCal == [p.calBase, p.calNever, p.calExp])
   %       error('Invalid doCal');
   %    end
      validateattributes(p.doCal, {'double'}, {'finite', 'nonnan', 'nonempty', 'integer', 'scalar'})
      validateattributes(p.lbV, {'double'}, {'finite', 'nonnan', 'nonempty', 'real', 'size', size(p.valueV)})
      if any(p.lbV >= p.ubV)
         error('Invalid bounds');
      end

   end
   
end
end


% %% Validate doCal input
% function validate_docal(doCal)
%    if doCal ~= 0  &&  doCal ~= 1
%       error('Invalid doCal');
%    end
% end
% 
% %% Validate bounds
% function validate_bounds(lbV, ubV)
%    validateattributes(lbV, {'double'}, {'finite', 'nonnan', 'nonempty', 'real', 'size', size(ubV)})
%    if any(lbV >= ubV)
%       error('Invalid bounds');
%    end
% end