Mercurial > octave
view scripts/audio/@audiorecorder/get.m @ 20852:516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 12 Dec 2015 07:31:00 -0800 |
parents | 7503499a252b |
children | bac0d6f07a3e |
line wrap: on
line source
## Copyright (C) 2013-2015 Vytautas JanĨauskas ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {} {@var{value} =} get (@var{recorder}, @var{name}) ## @deftypefnx {} {@var{values} =} get (@var{recorder}) ## Return the @var{value} of the property identified by @var{name}. ## ## If @var{name} is a cell array, return the values of the properties ## corresponding to the elements of the cell array. Given only the recorder ## object, return a scalar structure with values of all properties of ## @var{recorder}. The field names of the structure correspond to property ## names. ## @end deftypefn function retval = get (varargin) if (nargin < 1 || nargin > 2) print_usage (); endif properties = __get_properties__ (varargin{1}); if (nargin == 1) retval = properties; elseif (nargin == 2) pnames = varargin{2}; if (ischar (pnames)) retval = getfield (properties, pnames); elseif (iscellstr (pnames)) retval = cell (size (pnames)); for i = 1:numel (pnames) retval{i} = getfield (properties, pnames{i}); endfor else error ("@audiorecorder/get: invalid name argument"); endif endif endfunction