Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_history_content.html @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:f0afece42f48
1 <!-- $Id: class_desc_history_content.html,v 1.11 2009/03/17 16:52:04 ingo Exp $ -->
2
3 <!-- ================================================== -->
4 <!-- BEGIN CONTENT FILE -->
5 <!-- ================================================== -->
6 <!-- ===== link box: Begin ===== -->
7 <p>
8 <table border="1" width="80%">
9 <tr>
10 <td>
11 <table border="0" cellpadding="5" class="categorylist" width="100%">
12 <colgroup>
13 <col width="37%"/>
14 <col width="63%"/>
15 </colgroup>
16 <tbody>
17 <tr valign="top">
18 <td>
19 <a href="class_desc_history.html#top_properties">Properties</a>
20 </td>
21 <td>Properties of the class</td>
22 </tr>
23 <tr valign="top">
24 <td>
25 <a href="class_desc_history.html#top_methods">Methods</a>
26 </td>
27 <td>All Methods of the class ordered by category.</td>
28 </tr>
29 <tr valign="top">
30 <td>
31 <a href="constructor_examples_main.html">Examples</a>
32 </td>
33 <td>Some constructor examples</td>
34 </tr>
35 </tbody>
36 </table>
37 </td>
38 </tr>
39 </table>
40 </p>
41 <!-- ===== link box: End ====== -->
42
43 <!-- ===== Back to Class descriptions ===== -->
44 <a href="class_desc_main.html">
45 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/>
46 Back to Class descriptions
47 </a>
48
49 <h2 class="title"><a name="top_properties"/>Properties</h2>
50 <p>
51 The LTPDA toolbox restrict access of the properties.<br></br>
52 The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br>
53 <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre>
54 The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
55 <pre class="programlisting">
56 For example:
57 obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span>
58 obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre>
59 </p>
60 <!-- ===== Properties ===== -->
61 <p>
62 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
63 <colgroup>
64 <col width="15%"/>
65 <col width="73%"/>
66 <col width="12%"/>
67 </colgroup>
68 <thead>
69 <tr valign="top">
70 <th class="categorylist">Properties</th>
71 <th class="categorylist">Description</th>
72 <th class="categorylist">Defined in class</th>
73 </tr>
74 </thead>
75 <tbody>
76 <!-- Property: 'methodInfo' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>methodInfo</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>minfo-object which is created in the called method.</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>history</p>
86 </td>
87 </tr>
88 <!-- Property: 'plistUsed' -->
89 <tr valign="top">
90 <td>
91 <p><tt>plistUsed</tt></p>
92 </td>
93 <td>
94 <p>plist-object which is used in the called method.</p>
95 </td>
96 <td>
97 <p>history</p>
98 </td>
99 </tr>
100 <!-- Property: 'methodInvars' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>methodInvars</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Variable names which are used for the called method.</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>history</p>
110 </td>
111 </tr>
112 <!-- Property: 'inhists' -->
113 <tr valign="top">
114 <td>
115 <p><tt>inhists</tt></p>
116 </td>
117 <td>
118 <p>The older history-objects</p>
119 </td>
120 <td>
121 <p>history</p>
122 </td>
123 </tr>
124 <!-- Property: 'proctime' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>proctime</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>Creation time of the history object (unix epoch time)</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>history</p>
134 </td>
135 </tr>
136 <!-- Property: 'version' -->
137 <tr valign="top">
138 <td>
139 <p><tt>version</tt></p>
140 </td>
141 <td>
142 <p>CVS version string of the constructor</p>
143 </td>
144 <td>
145 <p>history</p>
146 </td>
147 </tr>
148 </tbody>
149 </table>
150 </p>
151
152 <!-- ===== Top of page ===== -->
153 <a href="#top_of_page">
154 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
155 Back to Top
156 </a>
157
158 <h2 class="title"><a name="top_methods"/>Methods</h2>
159 <!-- ===== link box: Begin ===== -->
160 <p>
161 <table border="1" width="80%">
162 <tr>
163 <td>
164 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
165 <colgroup>
166 <col width="37%"/>
167 <col width="63%"/>
168 </colgroup>
169 <tbody>
170 <tr valign="top">
171 <td>
172 <a href="class_desc_history.html#constructor">Constructor</a>
173 </td>
174 <td>Constructor of this class</td>
175 </tr>
176 <tr valign="top">
177 <td>
178 <a href="class_desc_history.html#helper">Helper</a>
179 </td>
180 <td>Helper methods only for internal usage</td>
181 </tr>
182 <tr valign="top">
183 <td>
184 <a href="class_desc_history.html#internal">Internal</a>
185 </td>
186 <td>Internal methods only for internal usage</td>
187 </tr>
188 <tr valign="top">
189 <td>
190 <a href="class_desc_history.html#output">Output</a>
191 </td>
192 <td>Output methods</td>
193 </tr>
194 <tr valign="top">
195 <td>
196 <a href="class_desc_history.html#relational_operator">Relational Operator</a>
197 </td>
198 <td>Relational operator methods</td>
199 </tr>
200 </tbody>
201 </table>
202 </td>
203 </tr>
204 </table>
205 </p>
206 <!-- ===== link box: End ====== -->
207
208 <!-- ===== Top of page ===== -->
209 <a href="#top_of_page">
210 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
211 Back to Top
212 </a>
213
214 <!-- ===== Methods Category: Constructor ===== -->
215 <h3 class="title"><a name="constructor"/>Constructor</h3>
216 <p>
217 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
218 <colgroup>
219 <col width="15%"/>
220 <col width="73%"/>
221 <col width="12%"/>
222 </colgroup>
223 <thead>
224 <tr valign="top">
225 <th class="categorylist">Methods</th>
226 <th class="categorylist">Description</th>
227 <th class="categorylist">Defined in class</th>
228 </tr>
229 </thead>
230 <tbody>
231 <!-- history/history -->
232 <tr valign="top">
233 <td bgcolor="#f3f4f5">
234 <p><a href="matlab:doc('history')">history</a></p>
235 </td>
236 <td bgcolor="#f3f4f5">
237 <p>HISTORY History object class constructor.</p>
238 </td>
239 <td bgcolor="#f3f4f5">
240 <p>history</p>
241 </td>
242 </tr>
243 <!-- history/rebuild -->
244 <tr valign="top">
245 <td>
246 <p><a href="matlab:doc('history/rebuild')">rebuild</a></p>
247 </td>
248 <td>
249 <p>REBUILD rebuilds the orignal object using the history.</p>
250 </td>
251 <td>
252 <p>history</p>
253 </td>
254 </tr>
255 </tbody>
256 </table>
257 <!-- ===== Back to Top of Methods ===== -->
258 <a href="#top_methods">
259 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
260 Back to Top of Section
261 </a>
262
263 </p>
264
265 <!-- ===== Methods Category: Helper ===== -->
266 <h3 class="title"><a name="helper"/>Helper</h3>
267 <p>
268 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
269 <colgroup>
270 <col width="15%"/>
271 <col width="73%"/>
272 <col width="12%"/>
273 </colgroup>
274 <thead>
275 <tr valign="top">
276 <th class="categorylist">Methods</th>
277 <th class="categorylist">Description</th>
278 <th class="categorylist">Defined in class</th>
279 </tr>
280 </thead>
281 <tbody>
282 <!-- ltpda_obj/get -->
283 <tr valign="top">
284 <td bgcolor="#f3f4f5">
285 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
286 </td>
287 <td bgcolor="#f3f4f5">
288 <p>GET get a property of a object.</p>
289 </td>
290 <td bgcolor="#f3f4f5">
291 <p>ltpda_obj</p>
292 </td>
293 </tr>
294 <!-- ltpda_obj/isprop -->
295 <tr valign="top">
296 <td>
297 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
298 </td>
299 <td>
300 <p>ISPROP tests if the given field is one of the object properties.</p>
301 </td>
302 <td>
303 <p>ltpda_obj</p>
304 </td>
305 </tr>
306 </tbody>
307 </table>
308 <!-- ===== Back to Top of Methods ===== -->
309 <a href="#top_methods">
310 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
311 Back to Top of Section
312 </a>
313
314 </p>
315
316 <!-- ===== Methods Category: Internal ===== -->
317 <h3 class="title"><a name="internal"/>Internal</h3>
318 <p>
319 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
320 <colgroup>
321 <col width="15%"/>
322 <col width="73%"/>
323 <col width="12%"/>
324 </colgroup>
325 <thead>
326 <tr valign="top">
327 <th class="categorylist">Methods</th>
328 <th class="categorylist">Description</th>
329 <th class="categorylist">Defined in class</th>
330 </tr>
331 </thead>
332 <tbody>
333 <!-- history/getNodes -->
334 <tr valign="top">
335 <td bgcolor="#f3f4f5">
336 <p><a href="matlab:doc('history/getNodes')">getNodes</a></p>
337 </td>
338 <td bgcolor="#f3f4f5">
339 <p>GETNODES converts a history object to a nodes structure suitable for plotting as a tree.</p>
340 </td>
341 <td bgcolor="#f3f4f5">
342 <p>history</p>
343 </td>
344 </tr>
345 </tbody>
346 </table>
347 <!-- ===== Back to Top of Methods ===== -->
348 <a href="#top_methods">
349 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
350 Back to Top of Section
351 </a>
352
353 </p>
354
355 <!-- ===== Methods Category: Output ===== -->
356 <h3 class="title"><a name="output"/>Output</h3>
357 <p>
358 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
359 <colgroup>
360 <col width="15%"/>
361 <col width="73%"/>
362 <col width="12%"/>
363 </colgroup>
364 <thead>
365 <tr valign="top">
366 <th class="categorylist">Methods</th>
367 <th class="categorylist">Description</th>
368 <th class="categorylist">Defined in class</th>
369 </tr>
370 </thead>
371 <tbody>
372 <!-- history/char -->
373 <tr valign="top">
374 <td bgcolor="#f3f4f5">
375 <p><a href="matlab:doc('history/char')">char</a></p>
376 </td>
377 <td bgcolor="#f3f4f5">
378 <p>CHAR convert a param object into a string.</p>
379 </td>
380 <td bgcolor="#f3f4f5">
381 <p>history</p>
382 </td>
383 </tr>
384 <!-- history/display -->
385 <tr valign="top">
386 <td>
387 <p><a href="matlab:doc('history/display')">display</a></p>
388 </td>
389 <td>
390 <p>DISPLAY implement terminal display for history object.</p>
391 </td>
392 <td>
393 <p>history</p>
394 </td>
395 </tr>
396 <!-- history/dotview -->
397 <tr valign="top">
398 <td bgcolor="#f3f4f5">
399 <p><a href="matlab:doc('history/dotview')">dotview</a></p>
400 </td>
401 <td bgcolor="#f3f4f5">
402 <p>DOTVIEW view history of an object via the DOT interpreter.</p>
403 </td>
404 <td bgcolor="#f3f4f5">
405 <p>history</p>
406 </td>
407 </tr>
408 <!-- history/hist2dot -->
409 <tr valign="top">
410 <td>
411 <p><a href="matlab:doc('history/hist2dot')">hist2dot</a></p>
412 </td>
413 <td>
414 <p>HIST2DOT converts a history object to a 'DOT' file suitable for processing with graphviz</p>
415 </td>
416 <td>
417 <p>history</p>
418 </td>
419 </tr>
420 <!-- history/hist2m -->
421 <tr valign="top">
422 <td bgcolor="#f3f4f5">
423 <p><a href="matlab:doc('history/hist2m')">hist2m</a></p>
424 </td>
425 <td bgcolor="#f3f4f5">
426 <p>HIST2M writes a new m-file that reproduces the analysis described in the history object.</p>
427 </td>
428 <td bgcolor="#f3f4f5">
429 <p>history</p>
430 </td>
431 </tr>
432 <!-- history/plot -->
433 <tr valign="top">
434 <td>
435 <p><a href="matlab:doc('history/plot')">plot</a></p>
436 </td>
437 <td>
438 <p>PLOT plots a history object as a tree diagram.</p>
439 </td>
440 <td>
441 <p>history</p>
442 </td>
443 </tr>
444 <!-- history/string -->
445 <tr valign="top">
446 <td bgcolor="#f3f4f5">
447 <p><a href="matlab:doc('history/string')">string</a></p>
448 </td>
449 <td bgcolor="#f3f4f5">
450 <p>STRING writes a command string that can be used to recreate the input history object.</p>
451 </td>
452 <td bgcolor="#f3f4f5">
453 <p>history</p>
454 </td>
455 </tr>
456 </tbody>
457 </table>
458 <!-- ===== Back to Top of Methods ===== -->
459 <a href="#top_methods">
460 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
461 Back to Top of Section
462 </a>
463
464 </p>
465
466 <!-- ===== Methods Category: Relational_Operator ===== -->
467 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
468 <p>
469 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
470 <colgroup>
471 <col width="15%"/>
472 <col width="73%"/>
473 <col width="12%"/>
474 </colgroup>
475 <thead>
476 <tr valign="top">
477 <th class="categorylist">Methods</th>
478 <th class="categorylist">Description</th>
479 <th class="categorylist">Defined in class</th>
480 </tr>
481 </thead>
482 <tbody>
483 <!-- ltpda_obj/eq -->
484 <tr valign="top">
485 <td bgcolor="#f3f4f5">
486 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
487 </td>
488 <td bgcolor="#f3f4f5">
489 <p>EQ overloads the == operator for ltpda objects.</p>
490 </td>
491 <td bgcolor="#f3f4f5">
492 <p>ltpda_obj</p>
493 </td>
494 </tr>
495 <!-- ltpda_obj/ne -->
496 <tr valign="top">
497 <td>
498 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
499 </td>
500 <td>
501 <p>NE overloads the ~= operator for ltpda objects.</p>
502 </td>
503 <td>
504 <p>ltpda_obj</p>
505 </td>
506 </tr>
507 </tbody>
508 </table>
509 <!-- ===== Back to Top of Methods ===== -->
510 <a href="#top_methods">
511 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
512 Back to Top of Section
513 </a>
514
515 </p>
516
517 <!-- ================================================== -->
518 <!-- END CONTENT FILE -->
519 <!-- ================================================== -->