help/info/modulepar.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>modulepar</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="module.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  26     <td><a href="mtc.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>modulepar</h1>
  33 <hr align="left" width="75%">
  34 <p>The module parameter list defines a set of values that are supplied by the test environment at run-time. During test execution these values shall be treated as constants.
  35 <ul>
  36   <li>Module parameters shall not be of port type, timer type, default type, component type or anytype;</li>
  37   <li>a module parameter shall only be of type address if the address type is explicitly defined within the associated module;</li>
  38   <li>module parameters shall be declared within the module definition part only.;</li>
  39   <li>redefinition of the module parameter is not allowed;</li>
  40   <li>it is allowed to specify default values for module parameters in the module parameter list.</li>
  41 </ul>
  42 <p>Related keywords:</p>
  43 <ul>
  44   <li><a href="module.html"><b><font face="Courier New" color="#003258" size="4">module</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> visibility </i>] <font face="Courier New" color="#003258" size="5"><b>
  53         modulepar</b></font><i> module_parameter_def</i> <b><font face="Courier New" color="#003258" size="5">;</font></b></h3>
  54     <h3 align="center">[<i> visibility </i>] <font face="Courier New" color="#003258" size="5"><b>
  55         modulepar{</b></font><i> module_parameter_def [ <b><font face="Courier New" color="#003258" size="5">;</font></b> module_parameter_def... ]</i> <b><font face="Courier New" color="#003258" size="5">};</font></b></h3>
  56     </td>
  57   </tr>
  58 </table>
  59 </center>
  60 </div>
  61 <ul>
  62   <li>The <font face="Courier New" color="#003258" size="4"><b>modulepar</b></font> keyword introduces module parameter definitions.
  63   <li>The <i>module_parameter_def</i> lists one or more module parameters with the same type. Several parameters of the same type are separated by commas.
  64   <li>Parameters of different types shall be placed into separate module parameter definitions.
  65   <li>Values of module parameters can be defined or overwritten in the TITAN Run-time configuration file.
  66 </ul>
  67 <hr align="left" width="50%">
  68 <p><a name="parametrized">Example</a>
  69 <hr align="left" width="25%">
  70 <p><code> modulepar boolean tsp_main := false;<br>
  71 modulepar integer tsp_switch, tsp_emergency;<br>
  72 </code>
  73 <p>The module parameters consist one Boolean (tsp_main) and two integer module parameters (tsp_switch, tsp_emergency). The Boolean value has the default value false.</p>
  74 <hr align="left" width="25%">
  75 The above example could also have been written like this:
  76 <p><code> modulepar {<br>
  77 &nbsp;&nbsp;boolean tsp_main := false;<br>
  78 &nbsp;&nbsp;integer tsp_switch, tsp_emergency;<br>
  79 }<br>
  80 </code>
  81 <hr align="left" width="25%">
  82 <p><a HREF="BNF.html#modulepardef">BNF definition</a> of <font face="Courier New"> modulepar</font></p>
  83 </body>
  84 </html>