|
3430
|
1 ## Copyright (C) 1996, 1998 Auburn University. All rights reserved. |
|
|
2 ## |
|
|
3 ## This file is part of Octave. |
|
|
4 ## |
|
|
5 ## Octave is free software; you can redistribute it and/or modify it |
|
7016
|
6 ## under the terms of the GNU General Public License as published by |
|
|
7 ## the Free Software Foundation; either version 3 of the License, or (at |
|
|
8 ## your option) any later version. |
|
3430
|
9 ## |
|
7016
|
10 ## Octave is distributed in the hope that it will be useful, but |
|
|
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
|
|
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
|
|
13 ## General Public License for more details. |
|
3430
|
14 ## |
|
|
15 ## You should have received a copy of the GNU General Public License |
|
7016
|
16 ## along with Octave; see the file COPYING. If not, see |
|
|
17 ## <http://www.gnu.org/licenses/>. |
|
3430
|
18 |
|
6522
|
19 save_var = page_screen_output (); |
|
|
20 page_screen_output (1); |
|
3430
|
21 disp("Description of system data structure:") |
|
|
22 disp("A linear system is stored in a structure, and may be represented in") |
|
|
23 disp("ss (state space), tf (transfer function), and/or zp (zero-pole-gain)") |
|
|
24 disp("form.") |
|
|
25 disp(" ") |
|
|
26 disp("variables in all representations:") |
|
|
27 disp("inname: list of signal names (strings) containing name(s) of system ") |
|
|
28 disp(" inputs; see is_signal_list"); |
|
|
29 disp("n: number of continuous states") |
|
|
30 disp("nz: number of discrete states") |
|
|
31 disp("outname: list of signal names (strings) containing name(s) of system ") |
|
|
32 disp(" outputs"); |
|
|
33 disp(" ") |
|
|
34 disp("variables in all representations:(cont'd)") |
|
|
35 disp("sys: system status vector. This vector indicates both what") |
|
|
36 disp(" representation was used to initialize the system data structure") |
|
|
37 disp(" (called the primary system type) and which other representations") |
|
|
38 disp(" are currently up-to-date with the primary system type.") |
|
|
39 disp(" sys(0): primary system type") |
|
|
40 disp(" =0 for tf form") |
|
|
41 disp(" =1 for zp form") |
|
|
42 disp(" =2 for ss form") |
|
|
43 disp(" sys(1:3): indicate whether tf, zp, or ss, respectively, are") |
|
|
44 disp(" \"up to date\" (whether it is safe to use the variables") |
|
|
45 disp(" associated with these representations)") |
|
|
46 disp(" sys(1): = 1 if tf variables are up to date") |
|
|
47 disp(" = 0 else"); |
|
|
48 disp(" sys(2): = 1 if zp variables are up to date") |
|
|
49 disp(" = 0 else"); |
|
|
50 disp(" sys(3): = 1 if ss variables are up to date") |
|
|
51 disp(" = 0 else"); |
|
|
52 disp("You can update alternative representations internally with the") |
|
|
53 disp("sysupdate command:") |
|
|
54 disp(" ") |
|
|
55 help sysupdate |
|
|
56 disp("===============================") |
|
|
57 disp("More variables common to all representations in system data structures:"); |
|
|
58 disp("tsam: discrete time sampling interval ") |
|
|
59 disp(" =0 if system is purely continuous"); |
|
|
60 disp(" >0 if system has discrete-time states or outputs"); |
|
|
61 disp("yd: vector indicating which outputs are discrete time (i.e.,") |
|
|
62 disp(" produced by D/A converters) and which are continuous time.") |
|
|
63 disp(" yd(ii) = 0 if output ii is continuous, = 1 if discrete.") |
|
|
64 disp(" ") |
|
|
65 disp("===============================") |
|
|
66 disp("variables in tf representations (SISO only):") |
|
|
67 disp("num: vector of numerator coefficients") |
|
|
68 disp("den: vector of denominator coefficients") |
|
|
69 disp(" ") |
|
|
70 disp("===============================") |
|
|
71 disp("variables in zp representations (SISO only):") |
|
|
72 disp("zer: vector of system zeros") |
|
|
73 disp("pol: vector of system poles") |
|
|
74 disp("k: system leading coefficient") |
|
|
75 disp(" ") |
|
|
76 disp("===============================") |
|
|
77 disp("variables in ss representations:") |
|
|
78 disp("a,b,c,d: usual state-space matrices. If a system has both") |
|
|
79 disp(" continuous and discrete states, they are sorted so that") |
|
|
80 disp(" continuous states come first, then discrete states") |
|
|
81 disp(" ") |
|
|
82 disp("WARNING: some functions (e.g., bode) will not accept systems") |
|
|
83 disp("with both discrete and continuous states/outputs") |
|
|
84 disp("stname: list of signal names (strings) containing name(s) of system ") |
|
|
85 disp(" states"); |
|
|
86 disp("===============================") |
|
|
87 disp("Object oriented programming:") |
|
|
88 disp("It is recommended that users do not directly access the internal") |
|
|
89 disp("variables themselves, but use the interface functions") |
|
4771
|
90 disp(" fir ss tf sys2fir") |
|
3430
|
91 disp(" sys2ss sys2tf sys2zp syschtsam") |
|
|
92 disp(" sysdimensions sysgetsignals syssetsignals sysgettype") |
|
4771
|
93 disp(" zp ") |
|
3430
|
94 disp("to create/access internal variables. "); |
|
6522
|
95 page_screen_output (save_var); |
