[Octave-cvsupdate] SF.net SVN: octave:[10698] trunk/octave-forge/extra/control-devel/inst/@ iddata/iddata.m

[<par...@us...>]

Revision: 10698
          http://octave.svn.sourceforge.net/octave/?rev=10698&view=rev
Author:   paramaniac
Date:     2012-06-27 15:05:30 +0000 (Wed, 27 Jun 2012)
Log Message:
-----------
control-devel: describe iddata properties in help text

Modified Paths:
--------------
    trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m

Modified: trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m
===================================================================
--- trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m	2012-06-27 11:24:46 UTC (rev 10697)
+++ trunk/octave-forge/extra/control-devel/inst/@iddata/iddata.m	2012-06-27 15:05:30 UTC (rev 10698)
@@ -58,6 +58,53 @@
 ## iddata identification dataset.
 ## @end table
 ##
+## @strong{Option Keys and Values}
+## @table @var
+## @item 'expname'
+## The name of the experiments in @var{dat}.
+## Cell vector of length e containing strings.
+## Default names are @code{@{'exp1', 'exp2', ...@}}
+##
+## @item 'y'
+## Output signals.  See 'Inputs' for details.
+##
+## @item 'outname'
+## The name of the output channels in @var{dat}.
+## Cell vector of length p containing strings.
+## Default names are @code{@{'y1', 'y2', ...@}}
+##
+## @item 'outunit'
+## The units of the output channels in @var{dat}.
+## Cell vector of length p containing strings.
+##
+## @item 'u'
+## Input signals.  See 'Inputs' for details.
+##
+## @item 'inname'
+## The name of the input channels in @var{dat}.
+## Cell vector of length m containing strings.
+## Default names are @code{@{'u1', 'u2', ...@}}
+##
+## @item 'inunit'
+## The units of the input channels in @var{dat}.
+## Cell vector of length m containing strings.
+##
+## @item 'tsam'
+## Sampling time.  See 'Inputs' for details.
+##
+## @item 'timeunit'
+## The units of the sampling times in @var{dat}.
+## Cell vector of length e containing strings.
+##
+## @item 'name'
+## String containing the name of the dataset.
+##
+## @item 'notes'
+## String or cell of string containing comments.
+##
+## @item 'userdata'
+## Any data type.
+## @end table
 ## @end deftypefn
 
 ## Author: Lukas Reichlin <luk...@gm...>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.