1## Copyright (C) 2009-2016   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{keys}, @var{vals}] =} __sys_keys__ (@var{sys})
20## @deftypefnx {Function File} {[@var{keys}, @var{vals}] =} __sys_keys__ (@var{sys}, @var{aliases})
21## Return the list of keys as well as the assignable values for a tf object sys.
22## @end deftypefn
23
24## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
25## Created: October 2009
26## Version: 0.3
27
28function [keys, vals] = __sys_keys__ (sys, aliases = false)
29
30  ## cell vector of tf-specific keys
31  keys = {"num";
32          "den";
33          "tfvar";
34          "inv"};
35
36  ## cell vector of tf-specific assignable values
37  vals = {"p-by-m cell array of row vectors (m = number of inputs)";
38          "p-by-m cell array of row vectors (p = number of outputs)";
39          "string (usually s or z)";
40          "logical (true for negative powers of TF variable)"};
41
42  if (aliases)
43    ka = {"variable"};
44    keys = [keys; ka];
45  endif
46
47endfunction
48