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

   1 ## Copyright (C) 2009   Lukas F. Reichlin
   2 ##
   3 ## This file is part of LTI Syncope.
   4 ##
   5 ## LTI Syncope is free software: you can redistribute it and/or modify
   6 ## it under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation, either version 3 of the License, or
   8 ## (at your option) any later version.
   9 ##
  10 ## LTI Syncope is distributed in the hope that it will be useful,
  11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ## GNU General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 ## -*- texinfo -*-
  19 ## @deftypefn {Function File} {[@var{props}, @var{vals}] =} __property_names__ (@var{sys})
  20 ## @deftypefnx {Function File} {[@var{props}, @var{vals}] =} __property_names__ (@var{sys}, @var{"specific"})
  21 ## Return the list of properties as well as the assignable values for a ss object sys.
  22 ## @end deftypefn
  23
  24 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  25 ## Created: September 2009
  26 ## Version: 0.1
  27
  28 function [props, vals] = __property_names__ (sys, flg)
  29
  30   ## cell vector of ss-specific properties
  31   props = {"a";
  32            "b";
  33            "c";
  34            "d";
  35            "e";
  36            "stname";
  37            "scaled"};
  38
  39   ## cell vector of ss-specific assignable values
  40   vals = {"n-by-n matrix (n = number of states)";
  41           "n-by-m matrix (m = number of inputs)";
  42           "p-by-n matrix (p = number of outputs)";
  43           "p-by-m matrix";
  44           "n-by-n matrix";
  45           "n-by-1 cell vector of strings";
  46           "scalar logical value"};
  47
  48   if (nargin == 1)
  49     [ltiprops, ltivals] = __property_names__ (sys.lti);
  50
  51     props = [props;
  52              ltiprops];
  53
  54     vals = [vals;
  55             ltivals];
  56   endif
  57
  58 endfunction