Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 915100cedefb8f9145d4b367092591c524ead52e / . / TestON / Documentation / TestON_Document / TestON.bin.cli.TestThread-class.html
blob: 5c29da4862eb883cae3fbed736f8bafbce24f5d6 [file] [log] [blame]
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>TestON.bin.cli.TestThread</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17 <!-- Home link -->
18 <th>&nbsp;&nbsp;&nbsp;<a
19 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
21 <!-- Tree link -->
22 <th>&nbsp;&nbsp;&nbsp;<a
23 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
25 <!-- Index link -->
26 <th>&nbsp;&nbsp;&nbsp;<a
27 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
29 <!-- Help link -->
30 <th>&nbsp;&nbsp;&nbsp;<a
31 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]33 <!-- Project homepage -->
34 <th class="navbar" align="right" width="100%">
35 <table border="0" cellpadding="0" cellspacing="0">
36 <tr><th class="navbar" align="center"
37 >TestON</th>
38 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]39 </tr>
40</table>
41<table width="100%" cellpadding="0" cellspacing="0">
42 <tr valign="top">
43 <td width="100%">
44 <span class="breadcrumbs">
45 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
46 <a href="TestON.bin-module.html">Package&nbsp;bin</a> ::
47 <a href="TestON.bin.cli-module.html">Module&nbsp;cli</a> ::
48 Class&nbsp;TestThread
49 </span>
50 </td>
51 <td>
52 <table cellpadding="0" cellspacing="0">
53 <!-- hide/show private -->
54 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
55 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
56 <tr><td align="right"><span class="options"
57 >[<a href="frames.html" target="_top">frames</a
58 >]&nbsp;|&nbsp;<a href="TestON.bin.cli.TestThread-class.html"
59 target="_top">no&nbsp;frames</a>]</span></td></tr>
60 </table>
61 </td>
62 </tr>
63</table>
64<!-- ==================== CLASS DESCRIPTION ==================== -->
65<h1 class="epydoc">Class TestThread</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread">source&nbsp;code</a></span></p>
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]66<center>
67<center> <map id="class_hierarchy_for_testthread" name="class_hierarchy_for_testthread">
68<area shape="rect" id="node1" href="TestON.bin.cli.TestThread-class.html" title="TestThread" alt="" coords="28,118,116,143"/>
69<area shape="rect" id="node2" href="javascript:void(0);" title="threading.Thread" alt="" coords="13,62,131,87"/>
70<area shape="rect" id="node3" href="javascript:void(0);" title="threading._Verbose" alt="" coords="5,6,139,31"/>
71</map>
72 <img src="class_hierarchy_for_testthread.gif" alt='' usemap="#class_hierarchy_for_testthread" ismap="ismap" class="graph-without-title" />
73</center>
74</center>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]75<hr />
76<p>TestThread class will handle the test execution and will communicate
77 with the thread in the do_run.</p>
78
79<!-- ==================== INSTANCE METHODS ==================== -->
80<a name="section-InstanceMethods"></a>
81<table class="summary" border="1" cellpadding="3"
82 cellspacing="0" width="100%" bgcolor="white">
83<tr bgcolor="#70b0f0" class="table-header">
84 <td colspan="2" class="table-header">
85 <table border="0" cellpadding="0" cellspacing="0" width="100%">
86 <tr valign="top">
87 <td align="left"><span class="table-header">Instance Methods</span></td>
88 <td align="right" valign="top"
89 ><span class="options">[<a href="#section-InstanceMethods"
90 class="privatelink" onclick="toggle_private();"
91 >hide private</a>]</span></td>
92 </tr>
93 </table>
94 </td>
95</tr>
96<tr>
97 <td width="15%" align="right" valign="top" class="summary">
98 <span class="summary-type">&nbsp;</span>
99 </td><td class="summary">
100 <table width="100%" cellpadding="0" cellspacing="0" border="0">
101 <tr>
102 <td><span class="summary-sig"><a href="TestON.bin.cli.TestThread-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
103 <span class="summary-sig-arg">options</span>)</span><br />
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]104 This constructor should always be called with keyword arguments.</td>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]105 <td align="right" valign="top">
106 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.__init__">source&nbsp;code</a></span>
107
108 </td>
109 </tr>
110 </table>
111
112 </td>
113 </tr>
114<tr>
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type">&nbsp;</span>
117 </td><td class="summary">
118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <tr>
120 <td><span class="summary-sig"><a href="TestON.bin.cli.TestThread-class.html#run" class="summary-sig-name">run</a>(<span class="summary-sig-arg">self</span>)</span><br />
121 Will execute the test.</td>
122 <td align="right" valign="top">
123 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.run">source&nbsp;code</a></span>
124
125 </td>
126 </tr>
127 </table>
128
129 </td>
130 </tr>
131<tr>
132 <td width="15%" align="right" valign="top" class="summary">
133 <span class="summary-type">&nbsp;</span>
134 </td><td class="summary">
135 <table width="100%" cellpadding="0" cellspacing="0" border="0">
136 <tr>
137 <td><span class="summary-sig"><a name="pause"></a><span class="summary-sig-name">pause</span>(<span class="summary-sig-arg">self</span>)</span><br />
138 Will pause the test.</td>
139 <td align="right" valign="top">
140 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.pause">source&nbsp;code</a></span>
141
142 </td>
143 </tr>
144 </table>
145
146 </td>
147 </tr>
148<tr>
149 <td width="15%" align="right" valign="top" class="summary">
150 <span class="summary-type">&nbsp;</span>
151 </td><td class="summary">
152 <table width="100%" cellpadding="0" cellspacing="0" border="0">
153 <tr>
154 <td><span class="summary-sig"><a name="play"></a><span class="summary-sig-name">play</span>(<span class="summary-sig-arg">self</span>)</span><br />
155 Will resume the paused test.</td>
156 <td align="right" valign="top">
157 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.play">source&nbsp;code</a></span>
158
159 </td>
160 </tr>
161 </table>
162
163 </td>
164 </tr>
165<tr>
166 <td width="15%" align="right" valign="top" class="summary">
167 <span class="summary-type">&nbsp;</span>
168 </td><td class="summary">
169 <table width="100%" cellpadding="0" cellspacing="0" border="0">
170 <tr>
171 <td><span class="summary-sig"><a name="stop"></a><span class="summary-sig-name">stop</span>(<span class="summary-sig-arg">self</span>)</span><br />
172 Will stop the test execution.</td>
173 <td align="right" valign="top">
174 <span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.stop">source&nbsp;code</a></span>
175
176 </td>
177 </tr>
178 </table>
179
180 </td>
181 </tr>
182 <tr>
183 <td colspan="2" class="summary">
184 <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
185 <code>__repr__</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]186 <code>getName</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]187 <code>isAlive</code>,
188 <code>isDaemon</code>,
189 <code>is_alive</code>,
190 <code>join</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]191 <code>setDaemon</code>,
192 <code>setName</code>,
193 <code>start</code>
194 </p>
195 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]196 <code>_reset_internal_locks</code>,
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]197 <code>_set_daemon</code>,
198 <code>_set_ident</code>
199 </p></div>
200 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading._Verbose</code></b> (private):
201 <code>_note</code>
202 </p></div>
203 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
204 <code>__delattr__</code>,
205 <code>__format__</code>,
206 <code>__getattribute__</code>,
207 <code>__hash__</code>,
208 <code>__new__</code>,
209 <code>__reduce__</code>,
210 <code>__reduce_ex__</code>,
211 <code>__setattr__</code>,
212 <code>__sizeof__</code>,
213 <code>__str__</code>,
214 <code>__subclasshook__</code>
215 </p>
216 </td>
217 </tr>
218</table>
219<!-- ==================== PROPERTIES ==================== -->
220<a name="section-Properties"></a>
221<table class="summary" border="1" cellpadding="3"
222 cellspacing="0" width="100%" bgcolor="white">
223<tr bgcolor="#70b0f0" class="table-header">
224 <td colspan="2" class="table-header">
225 <table border="0" cellpadding="0" cellspacing="0" width="100%">
226 <tr valign="top">
227 <td align="left"><span class="table-header">Properties</span></td>
228 <td align="right" valign="top"
229 ><span class="options">[<a href="#section-Properties"
230 class="privatelink" onclick="toggle_private();"
231 >hide private</a>]</span></td>
232 </tr>
233 </table>
234 </td>
235</tr>
236 <tr>
237 <td colspan="2" class="summary">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]238 <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b>:
239 <code>daemon</code>,
240 <code>ident</code>,
241 <code>name</code>
242 </p>
243 <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code>threading.Thread</code></b> (private):
244 <code>_block</code>
245 </p></div>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]246 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
247 <code>__class__</code>
248 </p>
249 </td>
250 </tr>
251</table>
252<!-- ==================== METHOD DETAILS ==================== -->
253<a name="section-MethodDetails"></a>
254<table class="details" border="1" cellpadding="3"
255 cellspacing="0" width="100%" bgcolor="white">
256<tr bgcolor="#70b0f0" class="table-header">
257 <td colspan="2" class="table-header">
258 <table border="0" cellpadding="0" cellspacing="0" width="100%">
259 <tr valign="top">
260 <td align="left"><span class="table-header">Method Details</span></td>
261 <td align="right" valign="top"
262 ><span class="options">[<a href="#section-MethodDetails"
263 class="privatelink" onclick="toggle_private();"
264 >hide private</a>]</span></td>
265 </tr>
266 </table>
267 </td>
268</tr>
269</table>
270<a name="__init__"></a>
271<div>
272<table class="details" border="1" cellpadding="3"
273 cellspacing="0" width="100%" bgcolor="white">
274<tr><td>
275 <table width="100%" cellpadding="0" cellspacing="0" border="0">
276 <tr valign="top"><td>
277 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
278 <span class="sig-arg">options</span>)</span>
279 <br /><em class="fname">(Constructor)</em>
280 </h3>
281 </td><td align="right" valign="top"
282 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.__init__">source&nbsp;code</a></span>&nbsp;
283 </td>
284 </tr></table>
285
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]286 <p>This constructor should always be called with keyword arguments.
287 Arguments are:</p>
288 <p>*group* should be None; reserved for future extension when a
289 ThreadGroup class is implemented.</p>
290 <p>*target* is the callable object to be invoked by the run() method.
291 Defaults to None, meaning nothing is called.</p>
292 <p>*name* is the thread name. By default, a unique name is constructed of
293 the form &quot;Thread-N&quot; where N is a small decimal number.</p>
294 <p>*args* is the argument tuple for the target invocation. Defaults to
295 ().</p>
296 <p>*kwargs* is a dictionary of keyword arguments for the target
297 invocation. Defaults to {}.</p>
298 <p>If a subclass overrides the constructor, it must make sure to invoke
299 the base class constructor (Thread.__init__()) before doing anything else
300 to the thread.</p>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]301 <dl class="fields">
302 <dt>Overrides:
303 object.__init__
304 <dd><em class="note">(inherited documentation)</em></dd>
305 </dt>
306 </dl>
307</td></tr></table>
308</div>
309<a name="run"></a>
310<div>
311<table class="details" border="1" cellpadding="3"
312 cellspacing="0" width="100%" bgcolor="white">
313<tr><td>
314 <table width="100%" cellpadding="0" cellspacing="0" border="0">
315 <tr valign="top"><td>
316 <h3 class="epydoc"><span class="sig"><span class="sig-name">run</span>(<span class="sig-arg">self</span>)</span>
317 </h3>
318 </td><td align="right" valign="top"
319 ><span class="codelink"><a href="TestON.bin.cli-pysrc.html#TestThread.run">source&nbsp;code</a></span>&nbsp;
320 </td>
321 </tr></table>
322
323 <p>Will execute the test.</p>
324 <dl class="fields">
325 <dt>Overrides:
326 threading.Thread.run
327 </dt>
328 </dl>
329</td></tr></table>
330</div>
331<br />
332<!-- ==================== NAVIGATION BAR ==================== -->
333<table class="navbar" border="0" width="100%" cellpadding="0"
334 bgcolor="#a0c0ff" cellspacing="0">
335 <tr valign="middle">
336 <!-- Home link -->
337 <th>&nbsp;&nbsp;&nbsp;<a
338 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
339
340 <!-- Tree link -->
341 <th>&nbsp;&nbsp;&nbsp;<a
342 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
343
344 <!-- Index link -->
345 <th>&nbsp;&nbsp;&nbsp;<a
346 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
347
348 <!-- Help link -->
349 <th>&nbsp;&nbsp;&nbsp;<a
350 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
351
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]352 <!-- Project homepage -->
353 <th class="navbar" align="right" width="100%">
354 <table border="0" cellpadding="0" cellspacing="0">
355 <tr><th class="navbar" align="center"
356 >TestON</th>
357 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]358 </tr>
359</table>
360<table border="0" cellpadding="0" cellspacing="0" width="100%%">
361 <tr>
362 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]363 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]364 </td>
365 <td align="right" class="footer">
366 <a target="mainFrame" href="http://epydoc.sourceforge.net"
367 >http://epydoc.sourceforge.net</a>
368 </td>
369 </tr>
370</table>
371
372<script type="text/javascript">
373 <!--
374 // Private objects are initially displayed (because if
375 // javascript is turned off then we want them to be
376 // visible); but by default, we want to hide them. So hide
377 // them unless we have a cookie that says to show them.
378 checkCookie();
379 // -->
380</script>
381</body>
382</html>