Merge github.com:eclipse/titan.core
[deliverable/titan.core.git] / help / info / modulepar.html
CommitLineData
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 Gecse, Roland
13 Raduly, Csaba
14 Szabados, Kristof
15-->
970ed795
EL
16<html>
17<head>
18<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
19<meta http-equiv="Content-Language" content="en-us">
20<title>modulepar</title>
21</head>
22<body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
23<table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
24 <tr>
25 <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>
26 </tr>
27</table>
28<table border="0" align="right" cellpadding="0" cellspacing="0">
29 <tr>
30 <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
31 <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
32 <td><a href="module.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
33 <td><a href="mtc.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
34 </tr>
35</table>
36<p><br clear="all">
37</p>
38<hr>
39<h1>modulepar</h1>
40<hr align="left" width="75%">
41<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.
42<ul>
43 <li>Module parameters shall not be of port type, timer type, default type, component type or anytype;</li>
44 <li>a module parameter shall only be of type address if the address type is explicitly defined within the associated module;</li>
45 <li>module parameters shall be declared within the module definition part only.;</li>
46 <li>redefinition of the module parameter is not allowed;</li>
47 <li>it is allowed to specify default values for module parameters in the module parameter list.</li>
48</ul>
49<p>Related keywords:</p>
50<ul>
51 <li><a href="module.html"><b><font face="Courier New" color="#003258" size="4">module</font></b></a></li>
52</ul>
53<hr align="left" width="50%">
54<div align="center">
55<center>
56<table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
57 <tr>
58 <td width="100%">
59 <h3 align="center">[<i> visibility </i>] <font face="Courier New" color="#003258" size="5"><b>
60 modulepar</b></font><i> module_parameter_def</i> <b><font face="Courier New" color="#003258" size="5">;</font></b></h3>
61 <h3 align="center">[<i> visibility </i>] <font face="Courier New" color="#003258" size="5"><b>
62 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>
63 </td>
64 </tr>
65</table>
66</center>
67</div>
68<ul>
69 <li>The <font face="Courier New" color="#003258" size="4"><b>modulepar</b></font> keyword introduces module parameter definitions.
70 <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.
71 <li>Parameters of different types shall be placed into separate module parameter definitions.
72 <li>Values of module parameters can be defined or overwritten in the TITAN Run-time configuration file.
73</ul>
74<hr align="left" width="50%">
75<p><a name="parametrized">Example</a>
76<hr align="left" width="25%">
77<p><code> modulepar boolean tsp_main := false;<br>
78modulepar integer tsp_switch, tsp_emergency;<br>
79</code>
80<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>
81<hr align="left" width="25%">
82The above example could also have been written like this:
83<p><code> modulepar {<br>
84&nbsp;&nbsp;boolean tsp_main := false;<br>
85&nbsp;&nbsp;integer tsp_switch, tsp_emergency;<br>
86}<br>
87</code>
88<hr align="left" width="25%">
89<p><a HREF="BNF.html#modulepardef">BNF definition</a> of <font face="Courier New"> modulepar</font></p>
90</body>
91</html>
This page took 0.042511 seconds and 5 git commands to generate.