Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_cdata_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_cdata_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_cdata.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_cdata.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: 'yunits' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>yunits</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Units of the y-axis</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>cdata</p>
86 </td>
87 </tr>
88 <!-- Property: 'y' -->
89 <tr valign="top">
90 <td>
91 <p><tt>y</tt></p>
92 </td>
93 <td>
94 <p>Data values of the y-axis</p>
95 </td>
96 <td>
97 <p>cdata</p>
98 </td>
99 </tr>
100 <!-- Property: 'version' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>version</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>CVS version string of the constructor</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>cdata</p>
110 </td>
111 </tr>
112 </tbody>
113 </table>
114 </p>
115
116 <!-- ===== Top of page ===== -->
117 <a href="#top_of_page">
118 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
119 Back to Top
120 </a>
121
122 <h2 class="title"><a name="top_methods"/>Methods</h2>
123 <!-- ===== link box: Begin ===== -->
124 <p>
125 <table border="1" width="80%">
126 <tr>
127 <td>
128 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
129 <colgroup>
130 <col width="37%"/>
131 <col width="63%"/>
132 </colgroup>
133 <tbody>
134 <tr valign="top">
135 <td>
136 <a href="class_desc_cdata.html#constructor">Constructor</a>
137 </td>
138 <td>Constructor of this class</td>
139 </tr>
140 <tr valign="top">
141 <td>
142 <a href="class_desc_cdata.html#helper">Helper</a>
143 </td>
144 <td>Helper methods only for internal usage</td>
145 </tr>
146 <tr valign="top">
147 <td>
148 <a href="class_desc_cdata.html#internal">Internal</a>
149 </td>
150 <td>Internal methods only for internal usage</td>
151 </tr>
152 <tr valign="top">
153 <td>
154 <a href="class_desc_cdata.html#output">Output</a>
155 </td>
156 <td>Output methods</td>
157 </tr>
158 <tr valign="top">
159 <td>
160 <a href="class_desc_cdata.html#relational_operator">Relational Operator</a>
161 </td>
162 <td>Relational operator methods</td>
163 </tr>
164 </tbody>
165 </table>
166 </td>
167 </tr>
168 </table>
169 </p>
170 <!-- ===== link box: End ====== -->
171
172 <!-- ===== Top of page ===== -->
173 <a href="#top_of_page">
174 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
175 Back to Top
176 </a>
177
178 <!-- ===== Methods Category: Constructor ===== -->
179 <h3 class="title"><a name="constructor"/>Constructor</h3>
180 <p>
181 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
182 <colgroup>
183 <col width="15%"/>
184 <col width="73%"/>
185 <col width="12%"/>
186 </colgroup>
187 <thead>
188 <tr valign="top">
189 <th class="categorylist">Methods</th>
190 <th class="categorylist">Description</th>
191 <th class="categorylist">Defined in class</th>
192 </tr>
193 </thead>
194 <tbody>
195 <!-- cdata/cdata -->
196 <tr valign="top">
197 <td bgcolor="#f3f4f5">
198 <p><a href="matlab:doc('cdata')">cdata</a></p>
199 </td>
200 <td bgcolor="#f3f4f5">
201 <p>CDATA is the constant data class.</p>
202 </td>
203 <td bgcolor="#f3f4f5">
204 <p>cdata</p>
205 </td>
206 </tr>
207 </tbody>
208 </table>
209 <!-- ===== Back to Top of Methods ===== -->
210 <a href="#top_methods">
211 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
212 Back to Top of Section
213 </a>
214
215 </p>
216
217 <!-- ===== Methods Category: Helper ===== -->
218 <h3 class="title"><a name="helper"/>Helper</h3>
219 <p>
220 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
221 <colgroup>
222 <col width="15%"/>
223 <col width="73%"/>
224 <col width="12%"/>
225 </colgroup>
226 <thead>
227 <tr valign="top">
228 <th class="categorylist">Methods</th>
229 <th class="categorylist">Description</th>
230 <th class="categorylist">Defined in class</th>
231 </tr>
232 </thead>
233 <tbody>
234 <!-- ltpda_obj/get -->
235 <tr valign="top">
236 <td bgcolor="#f3f4f5">
237 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
238 </td>
239 <td bgcolor="#f3f4f5">
240 <p>GET get a property of a object.</p>
241 </td>
242 <td bgcolor="#f3f4f5">
243 <p>ltpda_obj</p>
244 </td>
245 </tr>
246 <!-- ltpda_obj/isprop -->
247 <tr valign="top">
248 <td>
249 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
250 </td>
251 <td>
252 <p>ISPROP tests if the given field is one of the object properties.</p>
253 </td>
254 <td>
255 <p>ltpda_obj</p>
256 </td>
257 </tr>
258 </tbody>
259 </table>
260 <!-- ===== Back to Top of Methods ===== -->
261 <a href="#top_methods">
262 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
263 Back to Top of Section
264 </a>
265
266 </p>
267
268 <!-- ===== Methods Category: Internal ===== -->
269 <h3 class="title"><a name="internal"/>Internal</h3>
270 <p>
271 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
272 <colgroup>
273 <col width="15%"/>
274 <col width="73%"/>
275 <col width="12%"/>
276 </colgroup>
277 <thead>
278 <tr valign="top">
279 <th class="categorylist">Methods</th>
280 <th class="categorylist">Description</th>
281 <th class="categorylist">Defined in class</th>
282 </tr>
283 </thead>
284 <tbody>
285 <!-- cdata/applymethod -->
286 <tr valign="top">
287 <td bgcolor="#f3f4f5">
288 <p><a href="matlab:doc('cdata/applymethod')">applymethod</a></p>
289 </td>
290 <td bgcolor="#f3f4f5">
291 <p>APPLYMETHOD applys the given method to the input 2D data.</p>
292 </td>
293 <td bgcolor="#f3f4f5">
294 <p>cdata</p>
295 </td>
296 </tr>
297 <!-- cdata/applyoperator -->
298 <tr valign="top">
299 <td>
300 <p><a href="matlab:doc('cdata/applyoperator')">applyoperator</a></p>
301 </td>
302 <td>
303 <p>APPLYOPERATOR applys the given operator to the two input data objects.</p>
304 </td>
305 <td>
306 <p>cdata</p>
307 </td>
308 </tr>
309 <!-- cdata/char -->
310 <tr valign="top">
311 <td bgcolor="#f3f4f5">
312 <p><a href="matlab:doc('cdata/char')">char</a></p>
313 </td>
314 <td bgcolor="#f3f4f5">
315 <p>CHAR convert a cdata-object into a string.</p>
316 </td>
317 <td bgcolor="#f3f4f5">
318 <p>cdata</p>
319 </td>
320 </tr>
321 <!-- cdata/getY -->
322 <tr valign="top">
323 <td>
324 <p><a href="matlab:doc('cdata/getY')">getY</a></p>
325 </td>
326 <td>
327 <p>GETY Get the property 'y'.</p>
328 </td>
329 <td>
330 <p>cdata</p>
331 </td>
332 </tr>
333 <!-- cdata/setY -->
334 <tr valign="top">
335 <td bgcolor="#f3f4f5">
336 <p><a href="matlab:doc('cdata/setY')">setY</a></p>
337 </td>
338 <td bgcolor="#f3f4f5">
339 <p>SETY Set the property 'y'.</p>
340 </td>
341 <td bgcolor="#f3f4f5">
342 <p>cdata</p>
343 </td>
344 </tr>
345 <!-- cdata/setYunits -->
346 <tr valign="top">
347 <td>
348 <p><a href="matlab:doc('cdata/setYunits')">setYunits</a></p>
349 </td>
350 <td>
351 <p>SETYUNITS Set the property 'yunits'.</p>
352 </td>
353 <td>
354 <p>cdata</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 <!-- cdata/display -->
385 <tr valign="top">
386 <td bgcolor="#f3f4f5">
387 <p><a href="matlab:doc('cdata/display')">display</a></p>
388 </td>
389 <td bgcolor="#f3f4f5">
390 <p>DISPLAY implement terminal display for cdata object.</p>
391 </td>
392 <td bgcolor="#f3f4f5">
393 <p>cdata</p>
394 </td>
395 </tr>
396 </tbody>
397 </table>
398 <!-- ===== Back to Top of Methods ===== -->
399 <a href="#top_methods">
400 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
401 Back to Top of Section
402 </a>
403
404 </p>
405
406 <!-- ===== Methods Category: Relational_Operator ===== -->
407 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
408 <p>
409 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
410 <colgroup>
411 <col width="15%"/>
412 <col width="73%"/>
413 <col width="12%"/>
414 </colgroup>
415 <thead>
416 <tr valign="top">
417 <th class="categorylist">Methods</th>
418 <th class="categorylist">Description</th>
419 <th class="categorylist">Defined in class</th>
420 </tr>
421 </thead>
422 <tbody>
423 <!-- ltpda_obj/eq -->
424 <tr valign="top">
425 <td bgcolor="#f3f4f5">
426 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
427 </td>
428 <td bgcolor="#f3f4f5">
429 <p>EQ overloads the == operator for ltpda objects.</p>
430 </td>
431 <td bgcolor="#f3f4f5">
432 <p>ltpda_obj</p>
433 </td>
434 </tr>
435 <!-- ltpda_obj/ne -->
436 <tr valign="top">
437 <td>
438 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
439 </td>
440 <td>
441 <p>NE overloads the ~= operator for ltpda objects.</p>
442 </td>
443 <td>
444 <p>ltpda_obj</p>
445 </td>
446 </tr>
447 </tbody>
448 </table>
449 <!-- ===== Back to Top of Methods ===== -->
450 <a href="#top_methods">
451 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
452 Back to Top of Section
453 </a>
454
455 </p>
456
457 <!-- ================================================== -->
458 <!-- END CONTENT FILE -->
459 <!-- ================================================== -->