Mercurial > octave-nkf
view scripts/miscellaneous/isappdata.m @ 19298:f0dcb44826f6
Overhaul appdata family of functions (getappdata, isappdata, rmappdata, setappdata).
* getappdata.m: Redo docstring. Match function variable names to
documentation. Place input validation first and make error messages
more specific. Add BIST tests.
* isappdata.m: Redo docstring. Match function variable names to documentation.
Make input validation more precise. Use try/catch block for performance
improvement. Add BIST tests.
* rmappdata.m: Redo docstring. Improve input validation. Remove one for loop
through vectorization. Add BIST tests.
* setappdata.m: Redo docstring. Make input validation more precise.
Use try/catch block for 80% performance improvement. Add BIST tests.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 18 Oct 2014 18:10:52 -0700 |
parents | 0a8c35ae5ce1 |
children | db92e7e28e1f |
line wrap: on
line source
## Copyright (C) 2010-2013 Ben Abbott ## ## 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 {Function File} {@var{valid} =} isappdata (@var{h}, @var{name}) ## Return true if the named application data, @var{name}, exists for the ## graphics object with handle @var{h}. ## ## @var{h} may also be a vector of graphics handles. ## @seealso{getappdata, setappdata, rmappdata, guidata, get, set, getpref, setpref} ## @end deftypefn ## Author: Ben Abbott <bpabbott@mac.com> ## Created: 2010-07-15 function valid = isappdata (h, name) if (nargin < 1 || nargin > 2) print_usage (); endif if (! all (ishandle (h(:)))) error ("isappdata: H must be a scalar or vector of graphic handles"); elseif (! ischar (name)) error ("isappdata: NAME must be a string"); endif valid = false (size (h)); for i = 1:numel (h) try appdata = get (h(i), "__appdata__"); if (isfield (appdata, name)) valid(i) = true; endif end_try_catch endfor endfunction %!test %! unwind_protect %! setappdata (0, "%hello%", "world"); %! assert (isappdata (0, "%hello%"), true); %! assert (isappdata ([0 0], "%hello%"), [true, true]); %! assert (isappdata (0, "%foobar%"), false); %! unwind_protect_cleanup %! rmappdata (0, "%hello%"); %! end_unwind_protect ## Test input validation %!error isappdata () %!error isappdata (1,2,3) %!error <H must be a scalar .* graphic handle> isappdata (-1, "hello") %!error <NAME must be a string> isappdata (0, 1)