function_test/Semantic_Analyser/xer/aa_optional_SE.ttcn removed
[deliverable/titan.core.git] / help / info / running.html
CommitLineData
970ed795
EL
1<!--
2 Copyright (c) 2000-2014 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>running</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="rnd.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
26 <td><a href="runs.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>running</h1>
33<blockquote>
34<p>1. <a href="#Checking components">Checking components</a></p>
35<p>2. <a href="#timer">Checking timers</a></p>
36</blockquote>
37<hr align="left" width="75%">
38<p>1. <a name="Checking components">Checking components</a></p>
39<hr align="left" width="50%">
40<p>The operation is used to <a href="#Example 1a">check</a> whether a given parallel test component is running (i.e., has neither timed out nor been stopped). The Boolean value true is returned if
41the component have been started but not yet terminated or stopped, false otherwise.</p>
42<ul>
43 <li>The operation does not block TTCN-3 program execution, i.e., it reflects the momentary state of the parallel test component and does not wait for its termination.</li>
44 <li>When the <a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a> keyword is used with the operation, it will return true if all parallel
45 test components started are executing their behavior.</li>
46 <li>When the <a href="any.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a> keyword is used with the operation, it will return true if at least one
47 parallel test component is executing its behavior.</li>
48</ul>
49<p>Related keywords:</p>
50<ul>
51 <li><a href="alive.html"><b><font face="Courier New" color="#003258" size="4">alive</font></b></a></li>
52 <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li>
53 <li><a href="any.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a></li>
54 <li><a href="component.html"> <b><font face="Courier New" color="#003258" size="4">component</font></b> </a></li>
55 <li><a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a></li>
56</ul>
57<hr align="left" width="50%">
58<div align="center">
59<center>
60<table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
61 <tr>
62 <td width="100%">
63 <h3 align="center"><i>component_reference</i><font face="Courier New" color="#003258" size="5"><b>.running;</b></font> &nbsp;</h3>
64 </td>
65 </tr>
66</table>
67</center>
68</div>
69<ul>
70 <li>
71 <p>The <i>component_reference</i> is one of the following:</p>
72 <ul>
73 <li>a reference returned by the <a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a> operation to refer to a given parallel test
74 component,</li>
75 <li>the keyword pair <a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a> <a href="component.html"> <b><font
76 face="Courier New" color="#003258" size="4">component</font></b> </a> to check whether all parallel test components are still running,</li>
77 <li>
78 <p>the keyword pair <a href="mtc.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a> <a href="component.html"> <b><font
79 face="Courier New" color="#003258" size="4">component</font></b></a>&nbsp; to check whether at least one parallel test component is still running</p>
80 </li>
81 </ul>
82 </li>
83 <li>
84 <p>The <b><font face="Courier New" color="#003258" size="4">running</font> </b> keyword denotes that (a) component(s) should be checked.</p>
85 </li>
86</ul>
87<hr align="left" width="50%">
88<p><a href="#Example 1a">Examples</a></p>
89<hr align="left" width="75%">
90<p>2. <a name="timer">Checking&nbsp; timers</a></p>
91<hr align="left" width="50%">
92<p>The operation is used to <a href="#timer_start">check</a> whether a given timer is running (i.e., has neither timed out nor been stopped). The Boolean value true is returned if the timer is
93running, false otherwise.</p>
94<ul>
95 <li>The operation does not block TTCN-3 program execution, i.e., it reflects the momentarily state of the timer and does not wait for timeout.</li>
96 <li><a name="stop_all">The</a> keyword <a href="any.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a> may be used to check whether <a href="#default">at least
97 one timer</a> is runnig.</li>
98</ul>
99<p>Related keywords:</p>
100<ul>
101 <li><a href="any.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a></li>
102 <li><a href="read.html"><b><font face="Courier New" color="#003258" size="4">read</font></b></a></li>
103 <li><a href="start.html"><b><font face="Courier New" color="#003258" size="4">start</font></b></a></li>
104 <li><a href="stop.html"><b><font face="Courier New" color="#003258" size="4">stop</font></b></a></li>
105 <li><a href="timer.html"><b><font face="Courier New" color="#003258" size="4">timer</font></b></a></li>
106 <li><a href="timeout.html"><b><font face="Courier New" color="#003258" size="4">timeout</font></b></a></li>
107</ul>
108<hr align="left" width="50%">
109<div align="center">
110<center>
111<table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
112 <tr>
113 <td width="100%">
114 <h3 align="center">( <i>timer_identifier</i> | <font face="Courier New" color="#003258" size="5"><b>any timer</b></font> )<font face="Courier New" color="#003258" size="5"><b>.running</b></font>
115 <font face="Courier New" color="#003258" size="5"><b>;</b></font></h3>
116 </td>
117 </tr>
118</table>
119</center>
120</div>
121<ul>
122 <li>
123 <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>
124 </li>
125</ul>
126<hr align="left" width="75%" color="#0094D2">
127<p>It is possible to check a member of an <a href="#array">timer array</a>.</p>
128<hr align="left" width="50%" color="#0094D2">
129<div align="center">
130<center>
131<table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
132 <tr>
133 <td width="100%">
134 <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
135 face="Courier New" color="#003258" size="5"><b>].runnig; </b></font></h3>
136 </td>
137 </tr>
138</table>
139</center>
140</div>
141<div align="center"></div>
142<ul>
143 <li>
144 <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>
145 </li>
146 <li>
147 <p><i>array_index</i> points out the timer to be checked.</p>
148 </li>
149</ul>
150<hr align="left" width="50%">
151<p><a name="Example 1a">Example 1a</a>:</p>
152<p><font face="Courier New">var boolean v_Tbana := vc_metro.running;<br>
153</font>
154<p>The variable v_Tbana gets the value true if the component with the reference vc_metro is running.</p>
155<hr align="left" width="50%">
156<p>Example 1b:</p>
157<p><font face="Courier New">var boolean v_Ubahn := all component.running;</font>
158<p>The variable v_Ubahn will true if all started parallel components are still running.</p>
159<hr align="left" width="50%">
160<p>Example 1c:</p>
161<p><font face="Courier New">var boolean v_metropolitain := any component.running;&nbsp;<br>
162</font>
163<p>The variable v_metropolitain is true if at least one parallel component is still running.</p>
164<hr align="left" width="50%">
165<p><a name="timer_start">Example 2a</a>:
166<p><font face="Courier New">var boolean v_coureur := T_hledat.running;<br>
167</font>
168<p>The variable v_coureur gets the value true if the global timer T_hledat is running.</p>
169<hr align="left" width="50%">
170<p><a name="default">Example 2b:</a>
171<p><font face="Courier New">var boolean v_forlasu := any timer.running;&nbsp;<br>
172</font>
173<p>The variable v_forlasu is true if at least one timer is running in the scope unit where the command have been issued.</p>
174<hr align="left" width="50%">
175<p><a name="array">Example 2c:</a>
176<p><font face="Courier New">var boolean v_medlem := Tl_Odeon[3].running;</font>
177<p>The variable v_medlem will true if the fourth timer of the array Tl_Odeon is still running.</p>
178<hr align="left" width="25%">
179<hr align="left" width="25%">
180<p><a HREF="BNF.html#runningop">BNF definition</a> of <font face="Courier New">component running</font></p>
181<p><a HREF="BNF.html#runningtimerop">BNF definition</a> of <font face="Courier New">timer runnig</font></p>
182</body>
183</html>
This page took 0.030754 seconds and 5 git commands to generate.