Mercurial > hg > ltpda

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