bdGetPar.m

%bdGetPar  Read a parameter from a system structure
%Usage:
%   [val,idx] = bdGetPar(sys,'name')
%where
%   sys is the system structure containing the parameter definition.
%   'name' is the string name of the parameter (sys.pardef(idx).name).
%   val is its corresponding value (sys.pardef(idx).value).
%   idx is its index in the sys.pardef array.
%   All output parameters are returned empty if no matching name was found.
%
%bdGetPar(sys) displays the names of all parameters in sys.
%bdGetPar(sys,'name') is equivalent to bdGetValue(sys.pardef,'name').
%  
%SEE ALSO
%  bdGetVar, bdGetLag, bdGetValue, bdGetValues
%
%AUTHORS
%  Stewart Heitmann (2019a)

% Copyright (C) 2016-2019 QIMR Berghofer Medical Research Institute
% All rights reserved.
%
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions
% are met:
%
% 1. Redistributions of source code must retain the above copyright
%    notice, this list of conditions and the following disclaimer.
% 
% 2. Redistributions in binary form must reproduce the above copyright
%    notice, this list of conditions and the following disclaimer in
%    the documentation and/or other materials provided with the
%    distribution.
%
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
% "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
% LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
% FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
% COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
% INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
% BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
% LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
% CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
% LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
% ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
% POSSIBILITY OF SUCH DAMAGE.
function [val,idx] = bdGetPar(sys,name)
    switch nargin
        case 0
            throwAsCaller(MException('bdGetPar:Syntax','Not enough input arguments'));
        case 1
            if isfield(sys,'pardef')
                disp({sys.pardef.name});
            end
        case 2
            [val,idx] = bdGetValue(sys.pardef,name);
        otherwise
            throwAsCaller(MException('bdGetPar:Syntax','Too many input arguments'));
    end
end