help/info/stop.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   Gecse, Roland
  14   Szabados, Kristof
  15   Szabo, Janos Zoltan – initial implementation
  16 -->
  17 <html>
  18 <head>
  19 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  20 <meta http-equiv="Content-Language" content="en-us">
  21 <title>stop</title>
  22 </head>
  23 <body bgcolor="#DAD3C5" vlink="#0094D2" link="#003258">
  24 <table align="left" border="0" cellspacing="0" cellpadding="0" valign=top>
  25   <tr>
  26     <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>
  27   </tr>
  28 </table>
  29 <table border="0" align="right" cellpadding="0" cellspacing="0">
  30   <tr>
  31     <td><a href="../titan_main.html" alt="contents"><img border="0" src="../images/ao.jpg" width="53" height="40"></a></td>
  32     <td><a href="../titan_index.html" alt="index"><img border="0" src="../images/up.jpg" width="53" height="40"></a></td>
  33     <td><a href="start.html" alt="previous"><img border="0" src="../images/left.jpg" width="53" height="40"></a></td>
  34     <td><a href="str2bit.html" alt="next"><img border="0" src="../images/right.jpg" width="53" height="40"></a></td>
  35   </tr>
  36 </table>
  37 <p><br clear="all">
  38 </p>
  39 <hr>
  40 <h1>stop</h1>
  41 <blockquote>
  42 <p>0. <a href="#Terminating execution">Terminating execution</a></p>
  43 <p>1. <a href="#Terminating a test component">Stopping components</a></p>
  44 <p>2. <a href="#Starting a port">Stopping ports</a></p>
  45 <p>3. <a href="#timer">Stopping timers</a></p>
  46 <p>4. <a href="profiler.html#1">Stopping the profiler</a></p>
  47 </blockquote>
  48 <hr align="left" width="75%">
  49 <h3>0. <a name="Terminating execution">Terminating execution</a></h3>
  50 <p>The stop statement is used to terminate test execution. Whenever a stop statement is reached, the execution of the underlying testcase is immediately terminatef. The result of execution will be
  51 error.
  52 <hr align="left" width="50%">
  53 <div align="center">
  54 <center>
  55 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  56   <tr>
  57     <td width="100%">
  58     <h3 align="center"><font face="Courier New" color="#003258" size="5"><b>stop;</b></font></h3>
  59     </td>
  60   </tr>
  61 </table>
  62 </center>
  63 </div>
  64 <hr align="left" width="50%">
  65 <p><a href="#Example1b">Examples:</a></p>
  66 <hr align="left" width="75%">
  67
  68
  69 <h3>1. <a name="Terminating a test component">Stopping components</a></h3>
  70 <ul>
  71   <li>When used in a test case, altstep or function that are executed on a test component, the keyword terminates the relevant test component;</li>
  72   <li>when used in the control part of a module or in a function used by the control part of a module, it terminates the execution of the module control part.</li>
  73   <li>When prefixed with a component reference, other than the own component will be stopped;</li>
  74   <li>when prefixed with the <a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a> <a href="component.html"> <b><font
  75     face="Courier New" color="#003258" size="4">component</font></b> </a> keyword pair, all components except the main test component will be stopped.</li>
  76 </ul>
  77 <p>Related keywords:</p>
  78 <ul>
  79   <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li>
  80   <li><a href="component.html"> <b><font face="Courier New" color="#003258" size="4">component</font></b> </a></li>
  81   <li><a href="create.html"><b><font face="Courier New" color="#003258" size="4">create</font></b></a></li>
  82   <li><a href="profiler.html"><b><font face="Courier New" color="#003258" size="4">@profiler</font></b></a></li>
  83 </ul>
  84 <hr align="left" width="50%">
  85 <div align="center">
  86 <center>
  87 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
  88   <tr>
  89     <td width="100%">
  90     <h3 align="center">[ <i>component_reference</i><font face="Courier New" color="#003258" size="5"><b>.</b></font>] <font face="Courier New" color="#003258" size="5"><b>stop;</b></font> &nbsp;
  91     </h3>
  92     </td>
  93   </tr>
  94 </table>
  95 </center>
  96 </div>
  97 <ul>
  98   <li>
  99   <p>The optional <i>component_reference</i> (used when other than the own component should be stopped) is one of the following:</p>
 100   <ul>
 101     <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 component,</li>
 102     <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
 103       face="Courier New" color="#003258" size="4">component</font></b> </a> when referring to all parallel test components (the command must be issued in the main test component),</li>
 104     <li>the keyword <a href="self.html"><b><font face="Courier New" color="#003258" size="4">self</font></b></a> when referring to the own component,</li>
 105     <li>the keyword <a href="mtc.html"><b><font face="Courier New" color="#003258" size="4">mtc</font></b></a> when referring to the main test component.<br>
 106     &nbsp;</li>
 107   </ul>
 108   </li>
 109   <li>
 110   <p>The <b><font face="Courier New" color="#003258" size="4">stop</font> </b> keyword denotes that (a) component(s) should be stopped.</p>
 111   </li>
 112 </ul>
 113 <hr align="left" width="50%">
 114 <p>See <a href="#Example 4:">Examples</a></p>
 115 <hr align="left" width="75%">
 116
 117
 118 <h3>2. <a name="Stopping a port">Stopping a port</a></h3>
 119 <hr align="left" width="50%">
 120 <p>The keyword may be used to stop a <a href="#Example 2a">port</a>.</p>
 121 <ul>
 122   <li>The operation causes listening at the named ports to cease and disallows the sending operations.</li>
 123   <li>The port may be restarted by a subsequent start operation.</li>
 124   <li>It is possible to stop all defined ports.</li>
 125 </ul>
 126 <p>Related keywords:</p>
 127 <ul>
 128   <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li>
 129   <li><a href="port.html"><b><font face="Courier New" color="#003258" size="4">port</font></b></a></li>
 130 </ul>
 131 <hr align="left" width="50%">
 132 <div align="center">
 133 <center>
 134 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
 135   <tr>
 136     <td width="100%">
 137     <h3 align="center"><i>port_reference</i><font face="Courier New" color="#003258" size="5"><b>.stop;</b></font></h3>
 138     </td>
 139   </tr>
 140 </table>
 141 </center>
 142 </div>
 143 <ul>
 144   <li>
 145   <p><i> port_reference</i> points out the port to be stopped.</p>
 146   <ul>
 147     <li>
 148     <p>the keywords <b><font face="Courier New" color="#003258" size="4">all port</font> </b> may be used to indicate that all defined ports must be stopped (see the <a href="#Example 2b">example
 149     2b</a>).</p>
 150     </li>
 151   </ul>
 152   </li>
 153   <li>
 154   <p>The <b><font face="Courier New" color="#003258" size="4">stop</font> </b> keyword introduces port stopping.</p>
 155   </li>
 156 </ul>
 157 <hr align="left" width="75%">
 158 <h3>3. <a name="timer">Stopping&nbsp; timers</a></h3>
 159 <hr align="left" width="50%">
 160 <p>The keyword may be used to indicate that a <a href="#timer_start">timer should stop running</a>.</p>
 161 <ul>
 162   <li><a name="stop_all">The</a> keyword <a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a> may be used to <a href="#default"> stop all timers</a> that are
 163   visible in the scope unit in which the operation has been called.</li>
 164   <li>Stopping an inactive timer is a valid operation, although it does not have any effect.</li>
 165   <li>Stopping an expired timer causes the entry for this timer in the timeout-list to be removed.</li>
 166 </ul>
 167 <p>Related keywords:</p>
 168 <ul>
 169   <li><a href="all.html"><b><font face="Courier New" color="#003258" size="4">all</font></b></a></li>
 170   <li><a href="read.html"><b><font face="Courier New" color="#003258" size="4">read</font></b></a></li>
 171   <li><a href="running.html"><b><font face="Courier New" color="#003258" size="4">running</font></b></a></li>
 172   <li><a href="timer.html"><b><font face="Courier New" color="#003258" size="4">timer</font></b></a></li>
 173   <li><a href="start.html"><b><font face="Courier New" color="#003258" size="4">start</font></b></a></li>
 174   <li><a href="timeout.html"><b><font face="Courier New" color="#003258" size="4">timeout</font></b></a></li>
 175 </ul>
 176 <hr align="left" width="50%">
 177 <div align="center">
 178 <center>
 179 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
 180   <tr>
 181     <td width="100%">
 182     <h3 align="center">( <i>timer_identifier</i> | <font face="Courier New" color="#003258" size="5"><b>all timer</b></font> )<font face="Courier New" color="#003258" size="5"><b>.stop</b></font>
 183     <font face="Courier New" color="#003258" size="5"><b>;</b></font></h3>
 184     </td>
 185   </tr>
 186 </table>
 187 </center>
 188 </div>
 189 <ul>
 190   <li>
 191   <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>
 192   </li>
 193 </ul>
 194 <hr align="left" width="50%">
 195 <p>It is possible to stop a member of an <a href="#array">timer array</a>.</p>
 196 <hr align="left" width="50%">
 197 <div align="center">
 198 <center>
 199 <table border="0" width="90%" bgcolor="#FFB599" cellpadding="4">
 200   <tr>
 201     <td width="100%">
 202     <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
 203       face="Courier New" color="#003258" size="5"><b>].stop; </b></font></h3>
 204     </td>
 205   </tr>
 206 </table>
 207 </center>
 208 </div>
 209 <div align="center"></div>
 210 <ul>
 211   <li>
 212   <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>
 213   </li>
 214   <li>
 215   <p><i>array_index</i> points out the timer to be stopped.</p>
 216   </li>
 217 </ul>
 218 <p><a href="#timer_start">Examples</a></p>
 219 <hr align="left" width="50%">
 220 <p><a name="Example 4:">Example 1a:</a>
 221 <p><font face="Courier New">self.stop; </font>
 222 <p>The own test component is terminated. (The command was issued in a test case, altstep or function that are executed on a test component).</p>
 223 <hr align="left" width="50%">
 224 <p><a name="Example1b">Example 1b</a>:
 225 <p><font face="Courier New">stop; </font>
 226 <p>The test case execution is interrupted.
 227 <hr align="left" width="50%">
 228 <p><a name="Example 1c">Example 1c</a>:
 229 <p><font face="Courier New">vc_Hivatkozaas.stop; </font>
 230 <p>The component with the reference vc_Hivatkozaas is stopped.</p>
 231 <hr align="left" width="50%">
 232 <p>Example 1d:
 233 <p><font face="Courier New">all component.stop; </font>
 234 <p>All test components except the main test controller are stopped.</p>
 235 <hr align="left" width="50%">
 236 <p>Example 1e:
 237 <p><font face="Courier New">self.stop; </font>
 238 <p>The own test component is stopped. It has the same effect as in <a href="#Example 4:">example 1a</a></p>
 239 <hr align="left" width="50%">
 240 <p>Example 1f:
 241 <p><font face="Courier New">mtc.stop; </font>
 242 <p>The main test component is stopped.</p>
 243 <hr align="left" width="50%">
 244 <p><a name="Example 2a">Example 2a</a>:
 245 <p><font face="Courier New">Kapu_PCO.stop;</font>
 246 <p>The port Kapu_PCO will be stopped.</p>
 247 <hr align="left" width="50%">
 248 <p><a name="Example 2b">Example 2b</a>:
 249 <p><font face="Courier New">all port.stop;</font>
 250 <p>All ports will be stopped.</p>
 251 <hr align="left" width="50%">
 252 <p><a name="timer_start">Example 3a</a>:
 253 <p><font face="Courier New">T_soek.stop;<br>
 254 </font>
 255 <p>The global timer T_soek is stopped provided that it was running, otherwise the command has no effect.</p>
 256 <hr align="left" width="50%">
 257 <p><a name="default">Example 3b:</a>
 258 <p><font face="Courier New">all timer.stop;&nbsp;<br>
 259 </font>
 260 <p>The local timer Tl_foerlorad is declared (1st line) and stoped with a duration of 20 ms (2nd line).</p>
 261 <hr align="left" width="50%">
 262 <p><a name="array">Example 3c:</a>
 263 <p><font face="Courier New">timer Tl_Denfert[2] := {-, 1E-1, -};<br>
 264 Tl_Denfert[1].stop(20E-3); </font>
 265 <p>The array of&nbsp; local timers declared is called Tl_denfert and consists of three timers . The second timer has the default value of 100 ms, the others have no default value(1st
 266 line).&nbsp;The second timer in the array is stoped for 20 ms, overwriting the default value of 100 ms (2nd line).</p>
 267 <hr align="left" width="25%">
 268 <hr align="left" width="25%">
 269 <p><a HREF="BNF.html#stoptcstatement">BNF definition</a> of <font face="Courier New">component stop</font></p>
 270 <p><a HREF="BNF.html#stoptimerstatement">BNF definition</a> of <font face="Courier New">timer stop</font></p>
 271 </body>
 272 </html>