Mercurial > hg > ltpda

comparison m-toolbox/html_help/help/ug/class_desc_time_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_time_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_time.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_time.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: 'utc_epoch_milli' -->
77 <tr valign="top">
78 <td bgcolor="#f3f4f5">
79 <p><tt>utc_epoch_milli</tt></p>
80 </td>
81 <td bgcolor="#f3f4f5">
82 <p>Unix epoch time in milliseconds. The underlying timezone is UTC</p>
83 </td>
84 <td bgcolor="#f3f4f5">
85 <p>time</p>
86 </td>
87 </tr>
88 <!-- Property: 'timezone' -->
89 <tr valign="top">
90 <td>
91 <p><tt>timezone</tt></p>
92 </td>
93 <td>
94 <p>Timezone of the current time</p>
95 </td>
96 <td>
97 <p>time</p>
98 </td>
99 </tr>
100 <!-- Property: 'timeformat' -->
101 <tr valign="top">
102 <td bgcolor="#f3f4f5">
103 <p><tt>timeformat</tt></p>
104 </td>
105 <td bgcolor="#f3f4f5">
106 <p>Time format of the current time</p>
107 </td>
108 <td bgcolor="#f3f4f5">
109 <p>time</p>
110 </td>
111 </tr>
112 <!-- Property: 'time_str' -->
113 <tr valign="top">
114 <td>
115 <p><tt>time_str</tt></p>
116 </td>
117 <td>
118 <p>Time string depending on the unix epoch time and time format</p>
119 </td>
120 <td>
121 <p>time</p>
122 </td>
123 </tr>
124 <!-- Property: 'version' -->
125 <tr valign="top">
126 <td bgcolor="#f3f4f5">
127 <p><tt>version</tt></p>
128 </td>
129 <td bgcolor="#f3f4f5">
130 <p>CVS version string of the constructor</p>
131 </td>
132 <td bgcolor="#f3f4f5">
133 <p>time</p>
134 </td>
135 </tr>
136 </tbody>
137 </table>
138 </p>
139
140 <!-- ===== Top of page ===== -->
141 <a href="#top_of_page">
142 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
143 Back to Top
144 </a>
145
146 <h2 class="title"><a name="top_methods"/>Methods</h2>
147 <!-- ===== link box: Begin ===== -->
148 <p>
149 <table border="1" width="80%">
150 <tr>
151 <td>
152 <table border="0" cellpadding="5" class="subcategorylist" width="100%">
153 <colgroup>
154 <col width="37%"/>
155 <col width="63%"/>
156 </colgroup>
157 <tbody>
158 <tr valign="top">
159 <td>
160 <a href="class_desc_time.html#arithmetic_operator">Arithmetic Operator</a>
161 </td>
162 <td></td>
163 </tr>
164 <tr valign="top">
165 <td>
166 <a href="class_desc_time.html#constructor">Constructor</a>
167 </td>
168 <td>Constructor of this class</td>
169 </tr>
170 <tr valign="top">
171 <td>
172 <a href="class_desc_time.html#helper">Helper</a>
173 </td>
174 <td>Helper methods only for internal usage</td>
175 </tr>
176 <tr valign="top">
177 <td>
178 <a href="class_desc_time.html#internal">Internal</a>
179 </td>
180 <td>Internal methods only for internal usage</td>
181 </tr>
182 <tr valign="top">
183 <td>
184 <a href="class_desc_time.html#output">Output</a>
185 </td>
186 <td>Output methods</td>
187 </tr>
188 <tr valign="top">
189 <td>
190 <a href="class_desc_time.html#relational_operator">Relational Operator</a>
191 </td>
192 <td>Relational operator methods</td>
193 </tr>
194 </tbody>
195 </table>
196 </td>
197 </tr>
198 </table>
199 </p>
200 <!-- ===== link box: End ====== -->
201
202 <!-- ===== Top of page ===== -->
203 <a href="#top_of_page">
204 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/>
205 Back to Top
206 </a>
207
208 <!-- ===== Methods Category: Arithmetic_Operator ===== -->
209 <h3 class="title"><a name="arithmetic_operator"/>Arithmetic Operator</h3>
210 <p>
211 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
212 <colgroup>
213 <col width="15%"/>
214 <col width="73%"/>
215 <col width="12%"/>
216 </colgroup>
217 <thead>
218 <tr valign="top">
219 <th class="categorylist">Methods</th>
220 <th class="categorylist">Description</th>
221 <th class="categorylist">Defined in class</th>
222 </tr>
223 </thead>
224 <tbody>
225 <!-- time/minus -->
226 <tr valign="top">
227 <td bgcolor="#f3f4f5">
228 <p><a href="matlab:doc('time/minus')">minus</a></p>
229 </td>
230 <td bgcolor="#f3f4f5">
231 <p>MINUS overloads - operator for time objects.</p>
232 </td>
233 <td bgcolor="#f3f4f5">
234 <p>time</p>
235 </td>
236 </tr>
237 <!-- time/plus -->
238 <tr valign="top">
239 <td>
240 <p><a href="matlab:doc('time/plus')">plus</a></p>
241 </td>
242 <td>
243 <p>PLUS overloads + operator for time objects.</p>
244 </td>
245 <td>
246 <p>time</p>
247 </td>
248 </tr>
249 </tbody>
250 </table>
251 <!-- ===== Back to Top of Methods ===== -->
252 <a href="#top_methods">
253 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
254 Back to Top of Section
255 </a>
256
257 </p>
258
259 <!-- ===== Methods Category: Constructor ===== -->
260 <h3 class="title"><a name="constructor"/>Constructor</h3>
261 <p>
262 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
263 <colgroup>
264 <col width="15%"/>
265 <col width="73%"/>
266 <col width="12%"/>
267 </colgroup>
268 <thead>
269 <tr valign="top">
270 <th class="categorylist">Methods</th>
271 <th class="categorylist">Description</th>
272 <th class="categorylist">Defined in class</th>
273 </tr>
274 </thead>
275 <tbody>
276 <!-- time/time -->
277 <tr valign="top">
278 <td bgcolor="#f3f4f5">
279 <p><a href="matlab:doc('time')">time</a></p>
280 </td>
281 <td bgcolor="#f3f4f5">
282 <p>TIME time object class constructor.</p>
283 </td>
284 <td bgcolor="#f3f4f5">
285 <p>time</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: Helper ===== -->
299 <h3 class="title"><a name="helper"/>Helper</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 <!-- ltpda_obj/get -->
316 <tr valign="top">
317 <td bgcolor="#f3f4f5">
318 <p><a href="matlab:doc('ltpda_obj/get')">get</a></p>
319 </td>
320 <td bgcolor="#f3f4f5">
321 <p>GET get a property of a object.</p>
322 </td>
323 <td bgcolor="#f3f4f5">
324 <p>ltpda_obj</p>
325 </td>
326 </tr>
327 <!-- ltpda_obj/isprop -->
328 <tr valign="top">
329 <td>
330 <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
331 </td>
332 <td>
333 <p>ISPROP tests if the given field is one of the object properties.</p>
334 </td>
335 <td>
336 <p>ltpda_obj</p>
337 </td>
338 </tr>
339 <!-- time/string -->
340 <tr valign="top">
341 <td bgcolor="#f3f4f5">
342 <p><a href="matlab:doc('time/string')">string</a></p>
343 </td>
344 <td bgcolor="#f3f4f5">
345 <p>STRING writes a command string that can be used to recreate the input time object.</p>
346 </td>
347 <td bgcolor="#f3f4f5">
348 <p>time</p>
349 </td>
350 </tr>
351 </tbody>
352 </table>
353 <!-- ===== Back to Top of Methods ===== -->
354 <a href="#top_methods">
355 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
356 Back to Top of Section
357 </a>
358
359 </p>
360
361 <!-- ===== Methods Category: Internal ===== -->
362 <h3 class="title"><a name="internal"/>Internal</h3>
363 <p>
364 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
365 <colgroup>
366 <col width="15%"/>
367 <col width="73%"/>
368 <col width="12%"/>
369 </colgroup>
370 <thead>
371 <tr valign="top">
372 <th class="categorylist">Methods</th>
373 <th class="categorylist">Description</th>
374 <th class="categorylist">Defined in class</th>
375 </tr>
376 </thead>
377 <tbody>
378 <!-- time/setEpochtime -->
379 <tr valign="top">
380 <td bgcolor="#f3f4f5">
381 <p><a href="matlab:doc('time/setEpochtime')">setEpochtime</a></p>
382 </td>
383 <td bgcolor="#f3f4f5">
384 <p>SETEPOCHTIME Set the property 'utc_epoch_milli'.</p>
385 </td>
386 <td bgcolor="#f3f4f5">
387 <p>time</p>
388 </td>
389 </tr>
390 <!-- time/setTime_str -->
391 <tr valign="top">
392 <td>
393 <p><a href="matlab:doc('time/setTime_str')">setTime_str</a></p>
394 </td>
395 <td>
396 <p>SETTIME_STR Set the property 'time_str'.</p>
397 </td>
398 <td>
399 <p>time</p>
400 </td>
401 </tr>
402 <!-- time/setTimeformat -->
403 <tr valign="top">
404 <td bgcolor="#f3f4f5">
405 <p><a href="matlab:doc('time/setTimeformat')">setTimeformat</a></p>
406 </td>
407 <td bgcolor="#f3f4f5">
408 <p>SETTIMEFORMAT Set the property 'timeformat'.</p>
409 </td>
410 <td bgcolor="#f3f4f5">
411 <p>time</p>
412 </td>
413 </tr>
414 <!-- time/setTimezone -->
415 <tr valign="top">
416 <td>
417 <p><a href="matlab:doc('time/setTimezone')">setTimezone</a></p>
418 </td>
419 <td>
420 <p>SETTIMEZONE Set the property 'timezone'.</p>
421 </td>
422 <td>
423 <p>time</p>
424 </td>
425 </tr>
426 </tbody>
427 </table>
428 <!-- ===== Back to Top of Methods ===== -->
429 <a href="#top_methods">
430 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
431 Back to Top of Section
432 </a>
433
434 </p>
435
436 <!-- ===== Methods Category: Output ===== -->
437 <h3 class="title"><a name="output"/>Output</h3>
438 <p>
439 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
440 <colgroup>
441 <col width="15%"/>
442 <col width="73%"/>
443 <col width="12%"/>
444 </colgroup>
445 <thead>
446 <tr valign="top">
447 <th class="categorylist">Methods</th>
448 <th class="categorylist">Description</th>
449 <th class="categorylist">Defined in class</th>
450 </tr>
451 </thead>
452 <tbody>
453 <!-- time/char -->
454 <tr valign="top">
455 <td bgcolor="#f3f4f5">
456 <p><a href="matlab:doc('time/char')">char</a></p>
457 </td>
458 <td bgcolor="#f3f4f5">
459 <p>CHAR convert a time object into a string.</p>
460 </td>
461 <td bgcolor="#f3f4f5">
462 <p>time</p>
463 </td>
464 </tr>
465 <!-- time/display -->
466 <tr valign="top">
467 <td>
468 <p><a href="matlab:doc('time/display')">display</a></p>
469 </td>
470 <td>
471 <p>DISPLAY overloads display functionality for time objects.</p>
472 </td>
473 <td>
474 <p>time</p>
475 </td>
476 </tr>
477 <!-- time/format -->
478 <tr valign="top">
479 <td bgcolor="#f3f4f5">
480 <p><a href="matlab:doc('time/format')">format</a></p>
481 </td>
482 <td bgcolor="#f3f4f5">
483 <p>FORMAT Returns the time in specified format.</p>
484 </td>
485 <td bgcolor="#f3f4f5">
486 <p>time</p>
487 </td>
488 </tr>
489 </tbody>
490 </table>
491 <!-- ===== Back to Top of Methods ===== -->
492 <a href="#top_methods">
493 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
494 Back to Top of Section
495 </a>
496
497 </p>
498
499 <!-- ===== Methods Category: Relational_Operator ===== -->
500 <h3 class="title"><a name="relational_operator"/>Relational Operator</h3>
501 <p>
502 <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%">
503 <colgroup>
504 <col width="15%"/>
505 <col width="73%"/>
506 <col width="12%"/>
507 </colgroup>
508 <thead>
509 <tr valign="top">
510 <th class="categorylist">Methods</th>
511 <th class="categorylist">Description</th>
512 <th class="categorylist">Defined in class</th>
513 </tr>
514 </thead>
515 <tbody>
516 <!-- ltpda_obj/eq -->
517 <tr valign="top">
518 <td bgcolor="#f3f4f5">
519 <p><a href="matlab:doc('ltpda_obj/eq')">eq</a></p>
520 </td>
521 <td bgcolor="#f3f4f5">
522 <p>EQ overloads the == operator for ltpda objects.</p>
523 </td>
524 <td bgcolor="#f3f4f5">
525 <p>ltpda_obj</p>
526 </td>
527 </tr>
528 <!-- ltpda_obj/ne -->
529 <tr valign="top">
530 <td>
531 <p><a href="matlab:doc('ltpda_obj/ne')">ne</a></p>
532 </td>
533 <td>
534 <p>NE overloads the ~= operator for ltpda objects.</p>
535 </td>
536 <td>
537 <p>ltpda_obj</p>
538 </td>
539 </tr>
540 </tbody>
541 </table>
542 <!-- ===== Back to Top of Methods ===== -->
543 <a href="#top_methods">
544 <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/>
545 Back to Top of Section
546 </a>
547
548 </p>
549
550 <!-- ================================================== -->
551 <!-- END CONTENT FILE -->
552 <!-- ================================================== -->