Initial commit
[pftoolbox.git] / simulators / @simulator / props.txt
blob5159b940a6e83237729e4cc121fd6442f1d68790
1 Help on properties of the simulator class.\r
2 \r
3 'model'\r
4 Model object. If no model is assigned, the object is considered empty\r
5 and can't be used for simulations.\r
6 \r
7 't'\r
8 Current time.\r
9 Will be used as the time of the next simulation step, if nothing else is\r
10 specified in the call to the filter method. See 'help simulator/simulate'\r
11 for more information.\r
13 'Ts'\r
14 Sample points of the last simulation. This is a column vector.\r
15 Ts(k) contains the time at step k.\r
17 'y'\r
18 Measurement data y(t) that was generated by the simulation.\r
19 Often used as input data for filter algorithms.\r
20 y(:,k) contains the "measurements" at step k.\r
22 'x'\r
23 The "true" x(t) corrresponding to the simulated y(t).\r
24 Often used for evaulating filters, by comparing the true values to the\r
25 filter estimates.\r
26 x(i,k) contains state i at step k.\r
28 'u'\r
29 Deterministic data used in the last simulation, where u(:,k) is\r
30 the data used at step k.\r
32 'historysize'\r
33 Size of the history buffer.\r
34 The default, historysize=0 means that no history buffers will be created,\r
35 and historysize=-1 creates buffers of unlimited size.\r
36 History buffers are turned off by default to gain performance.\r
38 'x_history'\r
39 History of x.\r
41 'y_history'\r
42 History of y.\r
44 'u_history'\r
45 History of u.\r
47 'Ts_history'\r
48 History of Ts.\r