projects / deliverable / titan.core.git / blame
| Commit | Line | Data |
|---|---|---|
| 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> | |
| a38c6d4c | 36 | <p>3. <a href="profiler.html#2">Starting the profiler</a></p> |
| 970ed795 EL |
37 | </blockquote> |
| 38 | <hr align="left" width="75%"> | |
| a38c6d4c | 39 | <h3>1. <a name="Checking components">Checking components</a></h3> |
| 970ed795 EL |
40 | <hr align="left" width="50%"> |
| 41 | <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 | |
| 42 | the component have been started but not yet terminated or stopped, false otherwise.</p> | |
| 43 | <ul> | |
| 44 | <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> | |
| 45 | <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 | |
| 46 | test components started are executing their behavior.</li> | |
| 47 | <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 | |
| 48 | parallel test component is executing its behavior.</li> | |
| 49 | </ul> | |
| 50 | <p>Related keywords:</p> | |
| 51 | <ul> | |
| 52 | <li><a href="alive.html"><b><font face="Courier New" color="#003258" size="4">alive</font></b></a></li> | |
| 53 | <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li> | |
| 54 | <li><a href="any.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a></li> | |
| 55 | <li><a href="component.html"> <b><font face="Courier New" color="#003258" size="4">component</font></b> </a></li> | |
| 56 | <li><a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a></li> | |
| a38c6d4c | 57 | <li><a href="profiler.html"><b><font face="Courier New" color="#003258" size="4">@profiler</font></b></a></li> |
| 970ed795 EL |
58 | </ul> |
| 59 | <hr align="left" width="50%"> | |
| 60 | <div align="center"> | |
| 61 | <center> | |
| 62 | <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4"> | |
| 63 | <tr> | |
| 64 | <td width="100%"> | |
| 65 | <h3 align="center"><i>component_reference</i><font face="Courier New" color="#003258" size="5"><b>.running;</b></font> </h3> | |
| 66 | </td> | |
| 67 | </tr> | |
| 68 | </table> | |
| 69 | </center> | |
| 70 | </div> | |
| 71 | <ul> | |
| 72 | <li> | |
| 73 | <p>The <i>component_reference</i> is one of the following:</p> | |
| 74 | <ul> | |
| 75 | <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 | |
| 76 | component,</li> | |
| 77 | <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 | |
| 78 | face="Courier New" color="#003258" size="4">component</font></b> </a> to check whether all parallel test components are still running,</li> | |
| 79 | <li> | |
| 80 | <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 | |
| 81 | face="Courier New" color="#003258" size="4">component</font></b></a> to check whether at least one parallel test component is still running</p> | |
| 82 | </li> | |
| 83 | </ul> | |
| 84 | </li> | |
| 85 | <li> | |
| 86 | <p>The <b><font face="Courier New" color="#003258" size="4">running</font> </b> keyword denotes that (a) component(s) should be checked.</p> | |
| 87 | </li> | |
| 88 | </ul> | |
| 89 | <hr align="left" width="50%"> | |
| a38c6d4c | 90 | <p>See <a href="#Example 1a">Examples</a></p> |
| 970ed795 | 91 | <hr align="left" width="75%"> |
| a38c6d4c | 92 | <h3>2. <a name="timer">Checking timers</a></h3> |
| 970ed795 EL |
93 | <hr align="left" width="50%"> |
| 94 | <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 | |
| 95 | running, false otherwise.</p> | |
| 96 | <ul> | |
| 97 | <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> | |
| 98 | <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 | |
| a38c6d4c | 99 | one timer</a> is running.</li> |
| 970ed795 EL |
100 | </ul> |
| 101 | <p>Related keywords:</p> | |
| 102 | <ul> | |
| 103 | <li><a href="any.html"><b><font face="Courier New" color="#003258" size="4">any</font></b></a></li> | |
| 104 | <li><a href="read.html"><b><font face="Courier New" color="#003258" size="4">read</font></b></a></li> | |
| 105 | <li><a href="start.html"><b><font face="Courier New" color="#003258" size="4">start</font></b></a></li> | |
| 106 | <li><a href="stop.html"><b><font face="Courier New" color="#003258" size="4">stop</font></b></a></li> | |
| 107 | <li><a href="timer.html"><b><font face="Courier New" color="#003258" size="4">timer</font></b></a></li> | |
| 108 | <li><a href="timeout.html"><b><font face="Courier New" color="#003258" size="4">timeout</font></b></a></li> | |
| 109 | </ul> | |
| 110 | <hr align="left" width="50%"> | |
| 111 | <div align="center"> | |
| 112 | <center> | |
| 113 | <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4"> | |
| 114 | <tr> | |
| 115 | <td width="100%"> | |
| 116 | <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> | |
| 117 | <font face="Courier New" color="#003258" size="5"><b>;</b></font></h3> | |
| 118 | </td> | |
| 119 | </tr> | |
| 120 | </table> | |
| 121 | </center> | |
| 122 | </div> | |
| 123 | <ul> | |
| 124 | <li> | |
| 125 | <p><i>timer_identifier</i> is the name used to refer to the timer. It must begin with a letter, may contain letters, numbers and underscore characters.</p> | |
| 126 | </li> | |
| 127 | </ul> | |
| a38c6d4c | 128 | <hr align="left" width="50%"> |
| 129 | <p>It is possible to check a member of a <a href="#array">timer array</a>.</p> | |
| 130 | <hr align="left" width="50%"> | |
| 131 | <p>See <a href="#Example 1c">Example 1c</a></p> | |
| 132 | <hr align="left" width="50%"> | |
| 970ed795 EL |
133 | <div align="center"> |
| 134 | <center> | |
| 135 | <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4"> | |
| 136 | <tr> | |
| 137 | <td width="100%"> | |
| 138 | <h3 align="center"><font face="Courier New" color="#003258" size="5"><b></b></font> <i>timer_identifier</i><font face="Courier New" color="#003258" size="5"><b>[</b></font><i>array_index</i><font | |
| a38c6d4c | 139 | face="Courier New" color="#003258" size="5"><b>].running; </b></font></h3> |
| 970ed795 EL |
140 | </td> |
| 141 | </tr> | |
| 142 | </table> | |
| 143 | </center> | |
| 144 | </div> | |
| 145 | <div align="center"></div> | |
| 146 | <ul> | |
| 147 | <li> | |
| 148 | <p><i>timer_identifier</i> is the name used to refer to the timer. It must begin with a letter, may contain letters, numbers and underscore characters.</p> | |
| 149 | </li> | |
| 150 | <li> | |
| 151 | <p><i>array_index</i> points out the timer to be checked.</p> | |
| 152 | </li> | |
| 153 | </ul> | |
| a38c6d4c | 154 | <hr align="left" width="75%"> |
| 155 | <h3>Examples</h3> | |
| 970ed795 EL |
156 | <p><a name="Example 1a">Example 1a</a>:</p> |
| 157 | <p><font face="Courier New">var boolean v_Tbana := vc_metro.running;<br> | |
| 158 | </font> | |
| 159 | <p>The variable v_Tbana gets the value true if the component with the reference vc_metro is running.</p> | |
| 160 | <hr align="left" width="50%"> | |
| a38c6d4c | 161 | |
| 970ed795 EL |
162 | <p>Example 1b:</p> |
| 163 | <p><font face="Courier New">var boolean v_Ubahn := all component.running;</font> | |
| 164 | <p>The variable v_Ubahn will true if all started parallel components are still running.</p> | |
| 165 | <hr align="left" width="50%"> | |
| a38c6d4c | 166 | <p><a href="#Example 1c">Example 1c</a></p> |
| 970ed795 EL |
167 | <p><font face="Courier New">var boolean v_metropolitain := any component.running; <br> |
| 168 | </font> | |
| 169 | <p>The variable v_metropolitain is true if at least one parallel component is still running.</p> | |
| 170 | <hr align="left" width="50%"> | |
| 171 | <p><a name="timer_start">Example 2a</a>: | |
| 172 | <p><font face="Courier New">var boolean v_coureur := T_hledat.running;<br> | |
| 173 | </font> | |
| 174 | <p>The variable v_coureur gets the value true if the global timer T_hledat is running.</p> | |
| 175 | <hr align="left" width="50%"> | |
| 176 | <p><a name="default">Example 2b:</a> | |
| 177 | <p><font face="Courier New">var boolean v_forlasu := any timer.running; <br> | |
| 178 | </font> | |
| 179 | <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> | |
| 180 | <hr align="left" width="50%"> | |
| 181 | <p><a name="array">Example 2c:</a> | |
| 182 | <p><font face="Courier New">var boolean v_medlem := Tl_Odeon[3].running;</font> | |
| 183 | <p>The variable v_medlem will true if the fourth timer of the array Tl_Odeon is still running.</p> | |
| 184 | <hr align="left" width="25%"> | |
| 185 | <hr align="left" width="25%"> | |
| 186 | <p><a HREF="BNF.html#runningop">BNF definition</a> of <font face="Courier New">component running</font></p> | |
| a38c6d4c | 187 | <p><a HREF="BNF.html#runningtimerop">BNF definition</a> of <font face="Courier New">timer runnnig</font></p> |
| 970ed795 EL |
188 | </body> |
| 189 | </html> |