octave_packages/control-2.3.52/@frd/__property_names__.m

   1 ## Copyright (C) 2010   Lukas F. Reichlin
   2 ##
   3 ## This program is free software: you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation, either version 3 of the License, or
   6 ## (at your option) any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful,
   9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11 ## GNU General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this program. If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {[@var{props}, @var{vals}] =} __property_names__ (@var{sys})
  18 ## @deftypefnx {Function File} {[@var{props}, @var{vals}] =} __property_names__ (@var{sys}, @var{"specific"})
  19 ## Return the list of properties as well as the assignable values for a frd object sys.
  20 ## @end deftypefn
  21
  22 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  23 ## Created: October 2010
  24 ## Version: 0.1
  25
  26 function [props, vals] = __property_names__ (sys, flg)
  27
  28   ## cell vector of tf-specific properties
  29   props = {"H";
  30            "w"};
  31
  32   ## cell vector of frd-specific assignable values
  33   vals = {"p-by-m-by-l array of complex frequency responses";
  34           "l-by-1 vector of real frequencies (l = length (w))"};
  35
  36   if (nargin == 1)
  37     [ltiprops, ltivals] = __property_names__ (sys.lti);
  38
  39     props = [props;
  40              ltiprops];
  41
  42     vals = [vals;
  43             ltivals];
  44   endif
  45
  46 endfunction