Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_unit_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_unit_content.html,v 1.3 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_unit.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_unit.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: 'strs' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>strs</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Unit character</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>unit</p>
86 </td>
87 </tr>
88 <!-- Property: 'exps' -->
89 <tr valign="top">
90 <td>
91 <p><tt>exps</tt></p>
92 </td>
93 <td>
94 <p>Exponent of the unit</p>
95 </td>
96 <td>
97 <p>unit</p>
98 </td>
99 </tr>
100 <!-- Property: 'vals' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>vals</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Number of the used unit prefix (mm -> 1e-3)</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>unit</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>unit</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_unit.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_unit.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_unit.html#output">Output</a>
161 </td>
162 <td>Output methods</td>
163 </tr>
164 <tr valign="top">
165 <td>
166 <a href="class_desc_unit.html#relational_operator">Relational Operator</a>
167 </td>
168 <td>Relational operator methods</td>
169 </tr>
170 </tbody>
171 </table>
172 </td>
173 </tr>
174 </table>
175 </p>
176 <!-- ===== link box: End ====== -->
177
178 <!-- ===== Top of page ===== -->
179 <a href="#top_of_page">
180 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
181 Back to Top
182 </a>
183
184 <!-- ===== Methods Category: Constructor ===== -->
185 <h3 class="title"><a name="constructor"/>Constructor</h3>
186 <p>
187 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
188 <colgroup>
189 <col width="15%"/>
190 <col width="73%"/>
191 <col width="12%"/>
192 </colgroup>
193 <thead>
194 <tr valign="top">
195 <th class="categorylist">Methods</th>
196 <th class="categorylist">Description</th>
197 <th class="categorylist">Defined in class</th>
198 </tr>
199 </thead>
200 <tbody>
201 <!-- unit/unit -->
202 <tr valign="top">
203 <td bgcolor="#f3f4f5">
204 <p><a href="matlab:doc('unit')">unit</a></p>
205 </td>
206 <td bgcolor="#f3f4f5">
207 <p>UNIT a helper class for implementing units in LTPDA.</p>
208 </td>
209 <td bgcolor="#f3f4f5">
210 <p>unit</p>
211 </td>
212 </tr>
213 </tbody>
214 </table>
215 <!-- ===== Back to Top of Methods ===== -->
216 <a href="#top_methods">
217 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
218 Back to Top of Section
219 </a>
220
221 </p>
222
223 <!-- ===== Methods Category: Helper ===== -->
224 <h3 class="title"><a name="helper"/>Helper</h3>
225 <p>
226 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
227 <colgroup>
228 <col width="15%"/>
229 <col width="73%"/>
230 <col width="12%"/>
231 </colgroup>
232 <thead>
233 <tr valign="top">
234 <th class="categorylist">Methods</th>
235 <th class="categorylist">Description</th>
236 <th class="categorylist">Defined in class</th>
237 </tr>
238 </thead>
239 <tbody>
240 <!-- ltpda_obj/get -->
241 <tr valign="top">
242 <td bgcolor="#f3f4f5">
243 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
244 </td>
245 <td bgcolor="#f3f4f5">
246 <p>GET get a property of a object.</p>
247 </td>
248 <td bgcolor="#f3f4f5">
249 <p>ltpda_obj</p>
250 </td>
251 </tr>
252 <!-- ltpda_obj/isprop -->
253 <tr valign="top">
254 <td>
255 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
256 </td>
257 <td>
258 <p>ISPROP tests if the given field is one of the object properties.</p>
259 </td>
260 <td>
261 <p>ltpda_obj</p>
262 </td>
263 </tr>
264 <!-- unit/string -->
265 <tr valign="top">
266 <td bgcolor="#f3f4f5">
267 <p><a href="matlab:doc('unit/string')">string</a></p>
268 </td>
269 <td bgcolor="#f3f4f5">
270 <p>STRING converts a unit object to a command string which will recreate the unit object.</p>
271 </td>
272 <td bgcolor="#f3f4f5">
273 <p>unit</p>
274 </td>
275 </tr>
276 <!-- unit/tolabel -->
277 <tr valign="top">
278 <td>
279 <p><a href="matlab:doc('unit/tolabel')">tolabel</a></p>
280 </td>
281 <td>
282 <p>TOLABEL converts a unit object to LaTeX string suitable for use as axis</p>
283 </td>
284 <td>
285 <p>unit</p>
286 </td>
287 </tr>
288 </tbody>
289 </table>
290 <!-- ===== Back to Top of Methods ===== -->
291 <a href="#top_methods">
292 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
293 Back to Top of Section
294 </a>
295
296 </p>
297
298 <!-- ===== Methods Category: Output ===== -->
299 <h3 class="title"><a name="output"/>Output</h3>
300 <p>
301 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
302 <colgroup>
303 <col width="15%"/>
304 <col width="73%"/>
305 <col width="12%"/>
306 </colgroup>
307 <thead>
308 <tr valign="top">
309 <th class="categorylist">Methods</th>
310 <th class="categorylist">Description</th>
311 <th class="categorylist">Defined in class</th>
312 </tr>
313 </thead>
314 <tbody>
315 <!-- unit/display -->
316 <tr valign="top">
317 <td bgcolor="#f3f4f5">
318 <p><a href="matlab:doc('unit/display')">display</a></p>
319 </td>
320 <td bgcolor="#f3f4f5">
321 <p>DISPLAY display an unit object.</p>
322 </td>
323 <td bgcolor="#f3f4f5">
324 <p>unit</p>
325 </td>
326 </tr>
327 <!-- unit/factor -->
328 <tr valign="top">
329 <td>
330 <p><a href="matlab:doc('unit/factor')">factor</a></p>
331 </td>
332 <td>
333 <p>FACTOR factorises units in to numerator and denominator units.</p>
334 </td>
335 <td>
336 <p>unit</p>
337 </td>
338 </tr>
339 </tbody>
340 </table>
341 <!-- ===== Back to Top of Methods ===== -->
342 <a href="#top_methods">
343 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
344 Back to Top of Section
345 </a>
346
347 </p>
348
349 <!-- ===== Methods Category: Relational_Operator ===== -->
350 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
351 <p>
352 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
353 <colgroup>
354 <col width="15%"/>
355 <col width="73%"/>
356 <col width="12%"/>
357 </colgroup>
358 <thead>
359 <tr valign="top">
360 <th class="categorylist">Methods</th>
361 <th class="categorylist">Description</th>
362 <th class="categorylist">Defined in class</th>
363 </tr>
364 </thead>
365 <tbody>
366 <!-- unit/eq -->
367 <tr valign="top">
368 <td bgcolor="#f3f4f5">
369 <p><a href="matlab:doc('unit/eq')">eq</a></p>
370 </td>
371 <td bgcolor="#f3f4f5">
372 <p>EQ overloads the == operator for ltpda unit objects.</p>
373 </td>
374 <td bgcolor="#f3f4f5">
375 <p>unit</p>
376 </td>
377 </tr>
378 <!-- unit/ne -->
379 <tr valign="top">
380 <td>
381 <p><a href="matlab:doc('unit/ne')">ne</a></p>
382 </td>
383 <td>
384 <p>NE overloads the ~= operator for ltpda unit objects.</p>
385 </td>
386 <td>
387 <p>unit</p>
388 </td>
389 </tr>
390 </tbody>
391 </table>
392 <!-- ===== Back to Top of Methods ===== -->
393 <a href="#top_methods">
394 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
395 Back to Top of Section
396 </a>
397
398 </p>
399
400 <!-- ================================================== -->
401 <!-- END CONTENT FILE -->
402 <!-- ================================================== -->