projects / deliverable / titan.core.git / blame
| Commit | Line | Data |
|---|---|---|
| 970ed795 | 1 | <!-- |
| d44e3c4f | 2 | Copyright (c) 2000-2016 Ericsson Telecom AB |
| 970ed795 EL |
3 | All rights reserved. This program and the accompanying materials |
| 4 | are made available under the terms of the Eclipse Public License v1.0 | |
| 5 | which accompanies this distribution, and is available at | |
| 6 | http://www.eclipse.org/legal/epl-v10.html | |
| d44e3c4f | 7 | |
| 8 | Contributors: | |
| 9 | Baji, Laszlo | |
| 10 | Balasko, Jeno | |
| 11 | Farkas, Laszlo | |
| 12 | Szabados, Kristof | |
| 13 | Szabo, Janos Zoltan – initial implementation | |
| 14 | --> | |
| 970ed795 EL |
15 | <html> |
| 16 | <head> | |
| 17 | <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | |
| 18 | <meta http-equiv="Content-Language" content="en-us"> | |
| 19 | <title>read</title> | |
| 20 | </head> | |
| 21 | <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258"> | |
| 22 | <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top> | |
| 23 | <tr> | |
| 24 | <td width=105 height=40><a href="https://projects.eclipse.org/projects/tools.titan"><img src="../images/titan_transparent.gif" border=0 width=105 height=40 align="left" alt="Titan"></a></td> | |
| 25 | </tr> | |
| 26 | </table> | |
| 27 | <table border="0" align="right" cellpadding="0" cellspacing="0"> | |
| 28 | <tr> | |
| 29 | <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td> | |
| 30 | <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td> | |
| 31 | <td><a href="raise.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td> | |
| 32 | <td><a href="receive.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td> | |
| 33 | </tr> | |
| 34 | </table> | |
| 35 | <p><br clear="all"> | |
| 36 | </p> | |
| 37 | <hr> | |
| 38 | <h1>read</h1> | |
| 39 | <hr align="left" width="75%"> | |
| 40 | <p>The keyword is used to to <a href="#timer_start">retrieve the time</a> that has elapsed since the specified timer was started. The returned value is of type float.</p> | |
| 41 | <ul> | |
| 42 | <li>Applying the read operation to an inactive timer will return the float value zero (0.0).</li> | |
| 43 | </ul> | |
| 44 | <p>Related keywords:</p> | |
| 45 | <ul> | |
| 46 | <li><a href="running.html"><b><font face="Courier New" color="#003258" size="4">running</font></b></a></li> | |
| 47 | <li><a href="timer.html"><b><font face="Courier New" color="#003258" size="4">timer</font></b></a></li> | |
| 48 | <li><a href="start.html"><b><font face="Courier New" color="#003258" size="4">start</font></b></a></li> | |
| 49 | <li><a href="stop.html"><b><font face="Courier New" color="#003258" size="4">stop</font></b></a></li> | |
| 50 | <li><a href="timeout.html"><b><font face="Courier New" color="#003258" size="4">timeout</font></b></a></li> | |
| 51 | </ul> | |
| 52 | <hr align="left" width="50%"> | |
| 53 | <div align="center"> | |
| 54 | <center> | |
| 55 | <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4"> | |
| 56 | <tr> | |
| 57 | <td width="100%"> | |
| 58 | <h3 align="center"><i>timer_identifier</i><font face="Courier New" color="#003258" size="5"><b>.read</b></font><font face="Courier New" color="#003258" size="5"><b>;</b></font></h3> | |
| 59 | </td> | |
| 60 | </tr> | |
| 61 | </table> | |
| 62 | </center> | |
| 63 | </div> | |
| 64 | <ul> | |
| 65 | <li> | |
| 66 | <p><i>timer_identifier</i> is the name used to refer to the timer. It must begin with a letter, may contain letters, numbers and underscore characters.</p> | |
| 67 | </li> | |
| 68 | </ul> | |
| 69 | <hr align="left" width="75%" color="#0094D2"> | |
| 70 | <p>It is possible to read a member of a <a href="#array">timer array</a>.</p> | |
| 71 | <hr align="left" width="50%" color="#0094D2"> | |
| 72 | <div align="center"> | |
| 73 | <center> | |
| 74 | <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4"> | |
| 75 | <tr> | |
| 76 | <td width="100%"> | |
| 77 | <h3 align="center"><font face="Courier New" color="#003258" size="5"><b></b></font> <i>timer_identifier</i><font face="Courier New" color="#003258" size="5"><b>[</b></font><i>array_index</i><font | |
| 78 | face="Courier New" color="#003258" size="5"><b>].read; </b></font></h3> | |
| 79 | </td> | |
| 80 | </tr> | |
| 81 | </table> | |
| 82 | </center> | |
| 83 | </div> | |
| 84 | <div align="center"></div> | |
| 85 | <ul> | |
| 86 | <li> | |
| 87 | <p><i>timer_identifier</i> is the name used to refer to the timer. It must begin with a letter, may contain letters, numbers and underscore characters.</p> | |
| 88 | </li> | |
| 89 | <li> | |
| 90 | <p><i>array_index</i> points out the timer to be read.</p> | |
| 91 | </li> | |
| 92 | </ul> | |
| 93 | <hr align="left" width="50%"> | |
| 94 | <p><a name="timer_start">Example 1</a>: | |
| 95 | <p><font face="Courier New">var float vl_flottant := T_porslin.read;<br> | |
| 96 | </font> | |
| 97 | <p>The local variable vl_flottant is defined and used to store the time elapsed since the start of the global timer T_porslin.</p> | |
| 98 | <hr align="left" width="50%"> | |
| 99 | <p><a name="array">Example 2:</a> | |
| 100 | <p><font face="Courier New">var float v_ile := Tl_Rochereau[7].read;</font> | |
| 101 | <p>The variable v_ile is defined and used to store the time elapsed since the start of the eighth timer of the array T_Rochereau.</p> | |
| 102 | <hr align="left" width="25%"> | |
| 103 | <hr align="left" width="25%"> | |
| 104 | <p><a HREF="BNF.html#readtimerop">BNF definition</a> of <font face="Courier New">read</font></p> | |
| 105 | </body> | |
| 106 | </html> |