view aim-mat/tools/@parameter/gettext.m @ 0:74dedb26614d

Initial checkin of AIM-MAT version 1.5 (6.4.2011).

% method of class @parameter
% 
% (c) 2003-2008, University of Cambridge
% Maintained by Tom Walters ([e-mail]), written by Stefan Bleeck ([e-mail])
% http://www.pdn.cam.ac.uk/cnbh/aim2006/tools/parameter
% $Date: 2008-06-10 18:00:16 +0100 (Tue, 10 Jun 2008) $
function name=gettext(param,i,inbox)
% return the description text of the parameter with the entry number i.
% if i is a string then return the full string of the probably abbreviated

if nargin==1
    name=param.name;
    return
end

if isnumeric(i)
    name=param.entries{i}.text;
elseif ischar(i)
    if nargin==2 % search in all subsections
        inbox='all';
    end
    nr=getentrynumberbytext(param,i,inbox);
    name=param.entries{nr}.text;
end