]> Creatis software - CreaPhase.git/blobdiff - octave_packages/control-2.3.52/@lti/__property_names__.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / control-2.3.52 / @lti / __property_names__.m
diff --git a/octave_packages/control-2.3.52/@lti/__property_names__.m b/octave_packages/control-2.3.52/@lti/__property_names__.m
new file mode 100644 (file)
index 0000000..2f18750
--- /dev/null
@@ -0,0 +1,45 @@
+## Copyright (C) 2009, 2010   Lukas F. Reichlin
+##
+## This file is part of LTI Syncope.
+##
+## LTI Syncope 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.
+##
+## LTI Syncope 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 LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {[@var{props}, @var{vals}] =} __property_names__ (@var{sys})
+## Return the list of properties as well as the assignable values for an LTI object sys.
+## @end deftypefn
+
+## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
+## Created: September 2009
+## Version: 0.2
+
+function [props, vals] = __property_names__ (sys)
+
+  ## cell vector of lti-specific properties
+  props = {"tsam";
+           "inname";
+           "outname";
+           "name";
+           "notes";
+           "userdata"};
+
+  ## cell vector of lti-specific assignable values
+  vals = {"scalar (sample time in seconds)";
+          "m-by-1 cell vector of strings";
+          "p-by-1 cell vector of strings";
+          "string";
+          "string or cell of strings";
+          "any data type"};
+
+endfunction
\ No newline at end of file