help/info/log.html

   1 <!--
   2  Copyright (c) 2000-2016 Ericsson Telecom AB
   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
   7
   8  Contributors:
   9   Baji, Laszlo
  10   Balasko, Jeno
  11   Farkas, Laszlo
  12   Forstner, Matyas
  13   Szabados, Kristof
  14 -->
  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>log</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="lengthof.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  32     <td><a href="log2str.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>log</h1>
  39 <hr align="left" width="75%">
  40 <p>The log statement provides the means to write a character string to some logging device associated with test control or the test component in which the statement is used.
  41 <ul>
  42   <li>In TITAN, the logging device is the log file. As an extension to the standard, it is possible to refer also to constants, variables, templates or expressions in the argument. Every element
  43   of the argument may be repeated.</li>
  44 </ul>
  45 <hr align="left" width="50%">
  46 <div align="center">
  47 <center>
  48 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  49   <tr>
  50     <td width="100%">
  51     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>log ( "</b></font> <i>free_text_string</i> <font face="Courier New" color="#003258" size="5"><b>"</b></font> [<font
  52       face="Courier New" color="#003258" size="5"><b>,</b></font><i>constanst_ref</i>] [<font face="Courier New" color="#003258" size="5"><b>,</b></font><i>variable_ref</i>] [<font face="Courier New"
  53       color="#003258" size="5"><b>,</b></font><i>template_ref</i>] [<font face="Courier New" color="#003258" size="5"><b>,</b></font><i>expression</i>] <font face="Courier New" color="#003258"
  54       size="5"><b>);</b></font></h3>
  55     </td>
  56   </tr>
  57 </table>
  58 </center>
  59 </div>
  60 <ul>
  61   <li><i>free_text_string</i> is copied to the log file. It may contain numbers and letters from the BASIC LATIN and the LATIN-1 SUPPLEMENT character sets.</li>
  62 </ul>
  63 <div align="center">
  64 <center>
  65 <table border="0" width="100%" bgcolor="#C9C2BB" cellpadding="4">
  66   <tr>
  67     <td width="100%">
  68     <blockquote>
  69     <p><u>TITAN specific extensions to the standard:</u></p>
  70     </blockquote>
  71     <ul>
  72       <li>
  73       <p><i>constanst_ref</i> refers to a constant. The value of the constant appears in the log file.</p>
  74       </li>
  75       <li>
  76       <p><i>variable_ref</i> refers to a variable. The actual value of the variable is copied to the log file.</p>
  77       </li>
  78       <li>
  79       <p><i>template_ref</i> refers to a template. The log file will contain the actual field values of the referred template.</p>
  80       </li>
  81       <li>
  82       <p><i>expression</i> denotes a predefined or user-defined TTCN-3 function. Functions with actual arguments can also be passed to log statement. This will print the return value of the
  83       function into the log. The match operation is an exception: instead of the Boolean return value the detailed matching process is logged field-by-field.</p>
  84       </li>
  85     </ul>
  86     </td>
  87   </tr>
  88 </table>
  89 </center>
  90 </div>
  91 <hr align="left" width="50%">
  92 <p>Example 1:
  93 <p><font face="Courier New">log ("Note the following value: ", rnd(float .217))<br>
  94 </font>
  95 <p>The text between quotation marks will be added to the log file followed by the a random value generated using the seed 0.217.</p>
  96 <hr align="left" width="25%">
  97 <p><a HREF="../info/BNF.html#logstatement">BNF definition</a> of <font face="Courier New">log</font></p>
  98 </body>
  99 </html>