help/info/read.html

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