Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_provenance_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_provenance_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_provenance.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_provenance.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: 'creator' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>creator</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Current user of the LTPDA toolbox</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>provenance</p>
86 </td>
87 </tr>
88 <!-- Property: 'ip' -->
89 <tr valign="top">
90 <td>
91 <p><tt>ip</tt></p>
92 </td>
93 <td>
94 <p>IP address of the creator</p>
95 </td>
96 <td>
97 <p>provenance</p>
98 </td>
99 </tr>
100 <!-- Property: 'hostname' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>hostname</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Hostname of the creator</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>provenance</p>
110 </td>
111 </tr>
112 <!-- Property: 'os' -->
113 <tr valign="top">
114 <td>
115 <p><tt>os</tt></p>
116 </td>
117 <td>
118 <p>Used system of the creator</p>
119 </td>
120 <td>
121 <p>provenance</p>
122 </td>
123 </tr>
124 <!-- Property: 'matlab_version' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>matlab_version</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>MATLAB version</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>provenance</p>
134 </td>
135 </tr>
136 <!-- Property: 'sigproc_version' -->
137 <tr valign="top">
138 <td>
139 <p><tt>sigproc_version</tt></p>
140 </td>
141 <td>
142 <p>Signal Processing Toolbox version</p>
143 </td>
144 <td>
145 <p>provenance</p>
146 </td>
147 </tr>
148 <!-- Property: 'symbolic_math_version' -->
149 <tr valign="top">
150 <td bgcolor="#f3f4f5">
151 <p><tt>symbolic_math_version</tt></p>
152 </td>
153 <td bgcolor="#f3f4f5">
154 <p>Symbolic Math Toolbox version</p>
155 </td>
156 <td bgcolor="#f3f4f5">
157 <p>provenance</p>
158 </td>
159 </tr>
160 <!-- Property: 'optimization_version' -->
161 <tr valign="top">
162 <td>
163 <p><tt>optimization_version</tt></p>
164 </td>
165 <td>
166 <p>Optimization Toolbox version</p>
167 </td>
168 <td>
169 <p>provenance</p>
170 </td>
171 </tr>
172 <!-- Property: 'database_version' -->
173 <tr valign="top">
174 <td bgcolor="#f3f4f5">
175 <p><tt>database_version</tt></p>
176 </td>
177 <td bgcolor="#f3f4f5">
178 <p>Database Toolbox version</p>
179 </td>
180 <td bgcolor="#f3f4f5">
181 <p>provenance</p>
182 </td>
183 </tr>
184 <!-- Property: 'control_version' -->
185 <tr valign="top">
186 <td>
187 <p><tt>control_version</tt></p>
188 </td>
189 <td>
190 <p></p>
191 </td>
192 <td>
193 <p>provenance</p>
194 </td>
195 </tr>
196 <!-- Property: 'ltpda_version' -->
197 <tr valign="top">
198 <td bgcolor="#f3f4f5">
199 <p><tt>ltpda_version</tt></p>
200 </td>
201 <td bgcolor="#f3f4f5">
202 <p>LTPDA Toolbox version</p>
203 </td>
204 <td bgcolor="#f3f4f5">
205 <p>provenance</p>
206 </td>
207 </tr>
208 <!-- Property: 'version' -->
209 <tr valign="top">
210 <td>
211 <p><tt>version</tt></p>
212 </td>
213 <td>
214 <p>CVS version string of the constructor</p>
215 </td>
216 <td>
217 <p>provenance</p>
218 </td>
219 </tr>
220 </tbody>
221 </table>
222 </p>
223
224 <!-- ===== Top of page ===== -->
225 <a href="#top_of_page">
226 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
227 Back to Top
228 </a>
229
230 <h2 class="title"><a name="top_methods"/>Methods</h2>
231 <!-- ===== link box: Begin ===== -->
232 <p>
233 <table border="1" width="80%">
234 <tr>
235 <td>
236 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
237 <colgroup>
238 <col width="37%"/>
239 <col width="63%"/>
240 </colgroup>
241 <tbody>
242 <tr valign="top">
243 <td>
244 <a href="class_desc_provenance.html#constructor">Constructor</a>
245 </td>
246 <td>Constructor of this class</td>
247 </tr>
248 <tr valign="top">
249 <td>
250 <a href="class_desc_provenance.html#helper">Helper</a>
251 </td>
252 <td>Helper methods only for internal usage</td>
253 </tr>
254 <tr valign="top">
255 <td>
256 <a href="class_desc_provenance.html#output">Output</a>
257 </td>
258 <td>Output methods</td>
259 </tr>
260 <tr valign="top">
261 <td>
262 <a href="class_desc_provenance.html#relational_operator">Relational Operator</a>
263 </td>
264 <td>Relational operator methods</td>
265 </tr>
266 </tbody>
267 </table>
268 </td>
269 </tr>
270 </table>
271 </p>
272 <!-- ===== link box: End ====== -->
273
274 <!-- ===== Top of page ===== -->
275 <a href="#top_of_page">
276 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
277 Back to Top
278 </a>
279
280 <!-- ===== Methods Category: Constructor ===== -->
281 <h3 class="title"><a name="constructor"/>Constructor</h3>
282 <p>
283 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
284 <colgroup>
285 <col width="15%"/>
286 <col width="73%"/>
287 <col width="12%"/>
288 </colgroup>
289 <thead>
290 <tr valign="top">
291 <th class="categorylist">Methods</th>
292 <th class="categorylist">Description</th>
293 <th class="categorylist">Defined in class</th>
294 </tr>
295 </thead>
296 <tbody>
297 <!-- provenance/provenance -->
298 <tr valign="top">
299 <td bgcolor="#f3f4f5">
300 <p><a href="matlab:doc('provenance')">provenance</a></p>
301 </td>
302 <td bgcolor="#f3f4f5">
303 <p>PROVENANCE constructors for provenance class.</p>
304 </td>
305 <td bgcolor="#f3f4f5">
306 <p>provenance</p>
307 </td>
308 </tr>
309 </tbody>
310 </table>
311 <!-- ===== Back to Top of Methods ===== -->
312 <a href="#top_methods">
313 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
314 Back to Top of Section
315 </a>
316
317 </p>
318
319 <!-- ===== Methods Category: Helper ===== -->
320 <h3 class="title"><a name="helper"/>Helper</h3>
321 <p>
322 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
323 <colgroup>
324 <col width="15%"/>
325 <col width="73%"/>
326 <col width="12%"/>
327 </colgroup>
328 <thead>
329 <tr valign="top">
330 <th class="categorylist">Methods</th>
331 <th class="categorylist">Description</th>
332 <th class="categorylist">Defined in class</th>
333 </tr>
334 </thead>
335 <tbody>
336 <!-- ltpda_obj/get -->
337 <tr valign="top">
338 <td bgcolor="#f3f4f5">
339 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
340 </td>
341 <td bgcolor="#f3f4f5">
342 <p>GET get a property of a object.</p>
343 </td>
344 <td bgcolor="#f3f4f5">
345 <p>ltpda_obj</p>
346 </td>
347 </tr>
348 <!-- ltpda_obj/isprop -->
349 <tr valign="top">
350 <td>
351 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
352 </td>
353 <td>
354 <p>ISPROP tests if the given field is one of the object properties.</p>
355 </td>
356 <td>
357 <p>ltpda_obj</p>
358 </td>
359 </tr>
360 </tbody>
361 </table>
362 <!-- ===== Back to Top of Methods ===== -->
363 <a href="#top_methods">
364 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
365 Back to Top of Section
366 </a>
367
368 </p>
369
370 <!-- ===== Methods Category: Output ===== -->
371 <h3 class="title"><a name="output"/>Output</h3>
372 <p>
373 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
374 <colgroup>
375 <col width="15%"/>
376 <col width="73%"/>
377 <col width="12%"/>
378 </colgroup>
379 <thead>
380 <tr valign="top">
381 <th class="categorylist">Methods</th>
382 <th class="categorylist">Description</th>
383 <th class="categorylist">Defined in class</th>
384 </tr>
385 </thead>
386 <tbody>
387 <!-- provenance/char -->
388 <tr valign="top">
389 <td bgcolor="#f3f4f5">
390 <p><a href="matlab:doc('provenance/char')">char</a></p>
391 </td>
392 <td bgcolor="#f3f4f5">
393 <p>CHAR convert a provenance object into a string.</p>
394 </td>
395 <td bgcolor="#f3f4f5">
396 <p>provenance</p>
397 </td>
398 </tr>
399 <!-- provenance/display -->
400 <tr valign="top">
401 <td>
402 <p><a href="matlab:doc('provenance/display')">display</a></p>
403 </td>
404 <td>
405 <p>DISPLAY overload terminal display for provenance objects.</p>
406 </td>
407 <td>
408 <p>provenance</p>
409 </td>
410 </tr>
411 <!-- provenance/string -->
412 <tr valign="top">
413 <td bgcolor="#f3f4f5">
414 <p><a href="matlab:doc('provenance/string')">string</a></p>
415 </td>
416 <td bgcolor="#f3f4f5">
417 <p>STRING writes a command string that can be used to recreate the input provenance object.</p>
418 </td>
419 <td bgcolor="#f3f4f5">
420 <p>provenance</p>
421 </td>
422 </tr>
423 </tbody>
424 </table>
425 <!-- ===== Back to Top of Methods ===== -->
426 <a href="#top_methods">
427 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
428 Back to Top of Section
429 </a>
430
431 </p>
432
433 <!-- ===== Methods Category: Relational_Operator ===== -->
434 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
435 <p>
436 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
437 <colgroup>
438 <col width="15%"/>
439 <col width="73%"/>
440 <col width="12%"/>
441 </colgroup>
442 <thead>
443 <tr valign="top">
444 <th class="categorylist">Methods</th>
445 <th class="categorylist">Description</th>
446 <th class="categorylist">Defined in class</th>
447 </tr>
448 </thead>
449 <tbody>
450 <!-- ltpda_obj/eq -->
451 <tr valign="top">
452 <td bgcolor="#f3f4f5">
453 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
454 </td>
455 <td bgcolor="#f3f4f5">
456 <p>EQ overloads the == operator for ltpda objects.</p>
457 </td>
458 <td bgcolor="#f3f4f5">
459 <p>ltpda_obj</p>
460 </td>
461 </tr>
462 <!-- ltpda_obj/ne -->
463 <tr valign="top">
464 <td>
465 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
466 </td>
467 <td>
468 <p>NE overloads the ~= operator for ltpda objects.</p>
469 </td>
470 <td>
471 <p>ltpda_obj</p>
472 </td>
473 </tr>
474 </tbody>
475 </table>
476 <!-- ===== Back to Top of Methods ===== -->
477 <a href="#top_methods">
478 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
479 Back to Top of Section
480 </a>
481
482 </p>
483
484 <!-- ================================================== -->
485 <!-- END CONTENT FILE -->
486 <!-- ================================================== -->