Mercurial > octave
view scripts/audio/@audioplayer/subsref.m @ 30572:6d96538052b9
Overhaul @audioplayer class.
Eliminate unnecessary input validation that one argument is supplied to class
methods as interpreter guarantees the first argument is an @audioplayer
object. Accept case-insensitive property names for get()/set() functions.
Add BIST tests on a per function basis rather than only in @audioplayer
constructor.
* @audioplayer/__get_properties__.m: Eliminate nargin checking.
Use intermediate variable hplayer to clarify code.
Use ifelse() to simplify 5-line if/else/endif tree.
* @audioplayer/audioplayer.m: Add input validation to prevent
use of callback functions (not currently supported). Add FIXME
note and comment out rudimentary support for callback functions.
Remove tests of @audioplayer functionality to the methods files.
Add input validation BIST tests for callback function validation.
* @audioplayer/disp.m: Eliminate nargin checking.
Mark file as tested for BIST.
* @audioplayer/get.m: Rename "retval" to "value" in function prototype.
Use input parameters with names matching documentation rather than varargin.
Use new function getproperty() to do actual property retrieval rather than
getfield(). Add BIST tests.
* @audioplayer/get.m (getproperty): New function. Function checks property
names without regard to case sensitivity and also issues a meaningful error
message if the property name does not exist.
* @audioplayer/isplaying.m: Eliminate nargin checking. Add BIST tests.
* @audioplayer/pause.m: Eliminate nargin checking.
Mark file as tested for BIST.
* @audioplayer/play.m: Eliminate nargin checking. Use input parameters
with names matching documentation rather than varargin. Use intermediate
variable hplayer to clarify code. Mark file as tested for BIST.
* @audioplayer/playblocking.m: Use input parameters with names matching
documentation rather than varargin. Mark file as tested for BIST.
* @audioplayer/resume.m: Eliminate nargin checking.
Mark file as tested for BIST.
* @audioplayer/set.m: Eliminate nargin checking of first argument.
Use input parameter "player" for first argument rather than varargin.
Use intermediate variable hplayer to clarify code. Add BIST tests.
* @audioplayer/set.m (setproperty): Use lower() to implement case insensitive
matching of property names. Rewrite error() message to be clearer and
report the incorrect name.
* @audioplayer/stop.m: Eliminate nargin checking.
Mark file as tested for BIST.
* @audioplayer/subsasgn.m: Change output variable name to "player"
for clarity. Add BIST tests.
* @audioplayer/subsref.m: Add BIST tests.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 30 Dec 2021 16:11:55 -0800 |
parents | 82b685157e2b |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2013-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{value} =} subsref (@var{player}, @var{idx}) ## Perform subscripted selection on the audio player object @var{player}. ## ## Return the player property value named by @var{idx}. ## @seealso{@audioplayer/audioplayer} ## @end deftypefn function value = subsref (player, idx) if (nargin != 2) print_usage (); endif if (isempty (idx)) error ("@audioplayer/subsref: missing index"); endif if (strcmp (idx(1).type, ".")) field = idx.subs; value = get (player, field); else error ("@audioplayer/subsref: invalid subscript type"); endif endfunction %!testif HAVE_PORTAUDIO; audiodevinfo (0) > 0 %! player = audioplayer ([-1, 1], 44100, 8); %! set (player, "Tag", "mytag"); %! assert (player.Tag, "mytag"); ## Test input validation %!testif HAVE_PORTAUDIO; audiodevinfo (0) > 0 %! player = audioplayer ([-1, 1], 44100, 8); %! fail ("player(1).Tag", "invalid subscript type"); %! fail ("player{1}.Tag", "invalid subscript type");