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

   1 ## Copyright (C) 2009, 2010   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 ## Return the list of properties as well as the assignable values for an LTI object sys.
  21 ## @end deftypefn
  22
  23 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  24 ## Created: September 2009
  25 ## Version: 0.2
  26
  27 function [props, vals] = __property_names__ (sys)
  28
  29   ## cell vector of lti-specific properties
  30   props = {"tsam";
  31            "inname";
  32            "outname";
  33            "name";
  34            "notes";
  35            "userdata"};
  36
  37   ## cell vector of lti-specific assignable values
  38   vals = {"scalar (sample time in seconds)";
  39           "m-by-1 cell vector of strings";
  40           "p-by-1 cell vector of strings";
  41           "string";
  42           "string or cell of strings";
  43           "any data type"};
  44
  45 endfunction