Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 7eb384049281856e65d2579657592c84a75324e6 / . / TestON / Documentation / TestON_Document / TestON.core.openspeak.OpenSpeak-class.html
blob: 440bdb53b0d62f9bee60034e399d4a161ff83d21 [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.core.openspeak.OpenSpeak</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
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
41 <a href="TestON.core-module.html">Package&nbsp;core</a> ::
42 <a href="TestON.core.openspeak-module.html">Module&nbsp;openspeak</a> ::
43 Class&nbsp;OpenSpeak
44 </span>
45 </td>
46 <td>
47 <table cellpadding="0" cellspacing="0">
48 <!-- hide/show private -->
49 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
50 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
51 <tr><td align="right"><span class="options"
52 >[<a href="frames.html" target="_top">frames</a
53 >]&nbsp;|&nbsp;<a href="TestON.core.openspeak.OpenSpeak-class.html"
54 target="_top">no&nbsp;frames</a>]</span></td></tr>
55 </table>
56 </td>
57 </tr>
58</table>
59<!-- ==================== CLASS DESCRIPTION ==================== -->
60<h1 class="epydoc">Class OpenSpeak</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak">source&nbsp;code</a></span></p>
61<!-- ==================== INSTANCE METHODS ==================== -->
62<a name="section-InstanceMethods"></a>
63<table class="summary" border="1" cellpadding="3"
64 cellspacing="0" width="100%" bgcolor="white">
65<tr bgcolor="#70b0f0" class="table-header">
66 <td colspan="2" class="table-header">
67 <table border="0" cellpadding="0" cellspacing="0" width="100%">
68 <tr valign="top">
69 <td align="left"><span class="table-header">Instance Methods</span></td>
70 <td align="right" valign="top"
71 ><span class="options">[<a href="#section-InstanceMethods"
72 class="privatelink" onclick="toggle_private();"
73 >hide private</a>]</span></td>
74 </tr>
75 </table>
76 </td>
77</tr>
78<tr>
79 <td width="15%" align="right" valign="top" class="summary">
80 <span class="summary-type">&nbsp;</span>
81 </td><td class="summary">
82 <table width="100%" cellpadding="0" cellspacing="0" border="0">
83 <tr>
84 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
85 <td align="right" valign="top">
86 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.__init__">source&nbsp;code</a></span>
87
88 </td>
89 </tr>
90 </table>
91
92 </td>
93 </tr>
94<tr>
95 <td width="15%" align="right" valign="top" class="summary">
96 <span class="summary-type">&nbsp;</span>
97 </td><td class="summary">
98 <table width="100%" cellpadding="0" cellspacing="0" border="0">
99 <tr>
100 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#compiler" class="summary-sig-name">compiler</a>(<span class="summary-sig-arg">self</span>,
101 <span class="summary-sig-arg">**compileParameters</span>)</span><br />
102 This method will parse the openspeak file and will write to a python
103 module with the equivalent translations.</td>
104 <td align="right" valign="top">
105 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.compiler">source&nbsp;code</a></span>
106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#verify_and_translate" class="summary-sig-name">verify_and_translate</a>(<span class="summary-sig-arg">self</span>,
120 <span class="summary-sig-arg">line</span>)</span><br />
121 It will accept the each line and calls the suitable API to conver
122 into pyton equivalent syntax .</td>
123 <td align="right" valign="top">
124 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.verify_and_translate">source&nbsp;code</a></span>
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td><span class="summary-sig"><a name="translate_repeat"></a><span class="summary-sig-name">translate_repeat</span>(<span class="summary-sig-arg">self</span>,
139 <span class="summary-sig-arg">**repeatStatement</span>)</span><br />
140 this will transalte the repeat statement into a python equivalen
141 while loop</td>
142 <td align="right" valign="top">
143 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_repeat">source&nbsp;code</a></span>
144
145 </td>
146 </tr>
147 </table>
148
149 </td>
150 </tr>
151<tr>
152 <td width="15%" align="right" valign="top" class="summary">
153 <span class="summary-type">&nbsp;</span>
154 </td><td class="summary">
155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
156 <tr>
157 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_if_else_operator" class="summary-sig-name">translate_if_else_operator</a>(<span class="summary-sig-arg">self</span>,
158 <span class="summary-sig-arg">**loopBlock</span>)</span><br />
159 This method will translate if-else loop block into its equivalent
160 python code.</td>
161 <td align="right" valign="top">
162 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_if_else_operator">source&nbsp;code</a></span>
163
164 </td>
165 </tr>
166 </table>
167
168 </td>
169 </tr>
170<tr>
171 <td width="15%" align="right" valign="top" class="summary">
172 <span class="summary-type">&nbsp;</span>
173 </td><td class="summary">
174 <table width="100%" cellpadding="0" cellspacing="0" border="0">
175 <tr>
176 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_experimental_mode" class="summary-sig-name">translate_experimental_mode</a>(<span class="summary-sig-arg">self</span>,
177 <span class="summary-sig-arg">**modeType</span>)</span><br />
178 This API will translate statment EXPERIMENTAL MODE ON/OFF into python
179 equivalent.</td>
180 <td align="right" valign="top">
181 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_experimental_mode">source&nbsp;code</a></span>
182
183 </td>
184 </tr>
185 </table>
186
187 </td>
188 </tr>
189<tr>
190 <td width="15%" align="right" valign="top" class="summary">
191 <span class="summary-type">&nbsp;</span>
192 </td><td class="summary">
193 <table width="100%" cellpadding="0" cellspacing="0" border="0">
194 <tr>
195 <td><span class="summary-sig"><a name="interpret"></a><span class="summary-sig-name">interpret</span>(<span class="summary-sig-arg">self</span>,
196 <span class="summary-sig-arg">**interpetParameters</span>)</span><br />
197 This method will accept the OpenSpeak syntax into a string and will
198 return a python equivalent translations statement</td>
199 <td align="right" valign="top">
200 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.interpret">source&nbsp;code</a></span>
201
202 </td>
203 </tr>
204 </table>
205
206 </td>
207 </tr>
208<tr>
209 <td width="15%" align="right" valign="top" class="summary">
210 <span class="summary-type">&nbsp;</span>
211 </td><td class="summary">
212 <table width="100%" cellpadding="0" cellspacing="0" border="0">
213 <tr>
214 <td><span class="summary-sig"><a name="translate_logs"></a><span class="summary-sig-name">translate_logs</span>(<span class="summary-sig-arg">self</span>,
215 <span class="summary-sig-arg">**logStatement</span>)</span><br />
216 This will translate the OpenSpeak log message statements into python
217 equivalent to resultString and returns resultString</td>
218 <td align="right" valign="top">
219 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_logs">source&nbsp;code</a></span>
220
221 </td>
222 </tr>
223 </table>
224
225 </td>
226 </tr>
227<tr>
228 <td width="15%" align="right" valign="top" class="summary">
229 <span class="summary-type">&nbsp;</span>
230 </td><td class="summary">
231 <table width="100%" cellpadding="0" cellspacing="0" border="0">
232 <tr>
233 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_log_message" class="summary-sig-name">translate_log_message</a>(<span class="summary-sig-arg">self</span>,
234 <span class="summary-sig-arg">**messageStatement</span>)</span><br />
235 This API will translate log messages if it is a string or Variable or
236 combination of string and variable.</td>
237 <td align="right" valign="top">
238 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_log_message">source&nbsp;code</a></span>
239
240 </td>
241 </tr>
242 </table>
243
244 </td>
245 </tr>
246<tr>
247 <td width="15%" align="right" valign="top" class="summary">
248 <span class="summary-type">&nbsp;</span>
249 </td><td class="summary">
250 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <tr>
252 <td><span class="summary-sig"><a name="translate_assertion"></a><span class="summary-sig-name">translate_assertion</span>(<span class="summary-sig-arg">self</span>,
253 <span class="summary-sig-arg">**assertStatement</span>)</span><br />
254 This will translate the ASSERT &lt;value1&gt; &lt;COMPARISON
255 OPERATOR&gt; &lt;value2&gt; into python equivalent to resultString
256 and returns resultString</td>
257 <td align="right" valign="top">
258 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_assertion">source&nbsp;code</a></span>
259
260 </td>
261 </tr>
262 </table>
263
264 </td>
265 </tr>
266<tr>
267 <td width="15%" align="right" valign="top" class="summary">
268 <span class="summary-type">&nbsp;</span>
269 </td><td class="summary">
270 <table width="100%" cellpadding="0" cellspacing="0" border="0">
271 <tr>
272 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_response_result" class="summary-sig-name">translate_response_result</a>(<span class="summary-sig-arg">self</span>,
273 <span class="summary-sig-arg">**operatorStatement</span>)</span><br />
274 It will translate the LAST_RESPONSE or LAST_RESULT statement into its
275 equivalent.</td>
276 <td align="right" valign="top">
277 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_response_result">source&nbsp;code</a></span>
278
279 </td>
280 </tr>
281 </table>
282
283 </td>
284 </tr>
285<tr>
286 <td width="15%" align="right" valign="top" class="summary">
287 <span class="summary-type">&nbsp;</span>
288 </td><td class="summary">
289 <table width="100%" cellpadding="0" cellspacing="0" border="0">
290 <tr>
291 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_assertMessage" class="summary-sig-name">translate_assertMessage</a>(<span class="summary-sig-arg">self</span>,
292 <span class="summary-sig-arg">**messageStatement</span>)</span><br />
293 This API will facilitate the translation of assert ONPASS or ONFAIL
294 messages .</td>
295 <td align="right" valign="top">
296 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_assertMessage">source&nbsp;code</a></span>
297
298 </td>
299 </tr>
300 </table>
301
302 </td>
303 </tr>
304<tr>
305 <td width="15%" align="right" valign="top" class="summary">
306 <span class="summary-type">&nbsp;</span>
307 </td><td class="summary">
308 <table width="100%" cellpadding="0" cellspacing="0" border="0">
309 <tr>
310 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_operator" class="summary-sig-name">translate_operator</a>(<span class="summary-sig-arg">self</span>,
311 <span class="summary-sig-arg">**operatorStatement</span>)</span><br />
312 It will translate the operator for assertion , by ensuring against
313 given arguments.</td>
314 <td align="right" valign="top">
315 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_operator">source&nbsp;code</a></span>
316
317 </td>
318 </tr>
319 </table>
320
321 </td>
322 </tr>
323<tr>
324 <td width="15%" align="right" valign="top" class="summary">
325 <span class="summary-type">&nbsp;</span>
326 </td><td class="summary">
327 <table width="100%" cellpadding="0" cellspacing="0" border="0">
328 <tr>
329 <td><span class="summary-sig"><a name="translate_store"></a><span class="summary-sig-name">translate_store</span>(<span class="summary-sig-arg">self</span>,
330 <span class="summary-sig-arg">**storeStatement</span>)</span><br />
331 This will translate the STORE &lt;variable&gt; IN &lt;value&gt; or
332 &lt;variable&gt; = &lt;value&gt; into python equivalent to
333 resultString and returns resultString</td>
334 <td align="right" valign="top">
335 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_store">source&nbsp;code</a></span>
336
337 </td>
338 </tr>
339 </table>
340
341 </td>
342 </tr>
343<tr>
344 <td width="15%" align="right" valign="top" class="summary">
345 <span class="summary-type">&nbsp;</span>
346 </td><td class="summary">
347 <table width="100%" cellpadding="0" cellspacing="0" border="0">
348 <tr>
349 <td><span class="summary-sig"><a name="translate_disconnect"></a><span class="summary-sig-name">translate_disconnect</span>(<span class="summary-sig-arg">self</span>,
350 <span class="summary-sig-arg">**disconnectStatement</span>)</span><br />
351 This will translate the DISCONNECT &lt;component_name&gt; into python
352 equivalent to resultString and returns resultString</td>
353 <td align="right" valign="top">
354 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_disconnect">source&nbsp;code</a></span>
355
356 </td>
357 </tr>
358 </table>
359
360 </td>
361 </tr>
362<tr>
363 <td width="15%" align="right" valign="top" class="summary">
364 <span class="summary-type">&nbsp;</span>
365 </td><td class="summary">
366 <table width="100%" cellpadding="0" cellspacing="0" border="0">
367 <tr>
368 <td><span class="summary-sig"><a name="translate_onDOAs"></a><span class="summary-sig-name">translate_onDOAs</span>(<span class="summary-sig-arg">self</span>,
369 <span class="summary-sig-arg">**onDoStatement</span>)</span><br />
370 This will translate the ON &lt;component&gt; DO &lt;action&gt; USING
371 &lt;arg1&gt; AS &lt;value1&gt;,&lt;arg2&gt; AS &lt;value2&gt; into
372 python equivalent to resultString and returns resultString</td>
373 <td align="right" valign="top">
374 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_onDOAs">source&nbsp;code</a></span>
375
376 </td>
377 </tr>
378 </table>
379
380 </td>
381 </tr>
382<tr>
383 <td width="15%" align="right" valign="top" class="summary">
384 <span class="summary-type">&nbsp;</span>
385 </td><td class="summary">
386 <table width="100%" cellpadding="0" cellspacing="0" border="0">
387 <tr>
388 <td><span class="summary-sig"><a name="handle_conjuction"></a><span class="summary-sig-name">handle_conjuction</span>(<span class="summary-sig-arg">self</span>,
389 <span class="summary-sig-arg">**conjuctStatement</span>)</span><br />
390 This will handle the conjuctions</td>
391 <td align="right" valign="top">
392 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.handle_conjuction">source&nbsp;code</a></span>
393
394 </td>
395 </tr>
396 </table>
397
398 </td>
399 </tr>
400<tr>
401 <td width="15%" align="right" valign="top" class="summary">
402 <span class="summary-type">&nbsp;</span>
403 </td><td class="summary">
404 <table width="100%" cellpadding="0" cellspacing="0" border="0">
405 <tr>
406 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_usingas" class="summary-sig-name">translate_usingas</a>(<span class="summary-sig-arg">self</span>,
407 <span class="summary-sig-arg">**argumentAS</span>)</span><br />
408 This will tranlate USING argument AS value Statement into equivalent
409 argument passing.</td>
410 <td align="right" valign="top">
411 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_usingas">source&nbsp;code</a></span>
412
413 </td>
414 </tr>
415 </table>
416
417 </td>
418 </tr>
419<tr>
420 <td width="15%" align="right" valign="top" class="summary">
421 <span class="summary-type">&nbsp;</span>
422 </td><td class="summary">
423 <table width="100%" cellpadding="0" cellspacing="0" border="0">
424 <tr>
425 <td><span class="summary-sig"><a name="translate_connect"></a><span class="summary-sig-name">translate_connect</span>(<span class="summary-sig-arg">self</span>,
426 <span class="summary-sig-arg">**connectStatement</span>)</span><br />
427 This will translate the CONNECT &lt;component_name&gt; USING1
428 &lt;arg1&gt; AS &lt;value1&gt;, &lt;arg2&gt; AS &lt;value2&gt; into
429 python equivalent to resultString and returns resultString</td>
430 <td align="right" valign="top">
431 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_connect">source&nbsp;code</a></span>
432
433 </td>
434 </tr>
435 </table>
436
437 </td>
438 </tr>
439<tr>
440 <td width="15%" align="right" valign="top" class="summary">
441 <span class="summary-type">&nbsp;</span>
442 </td><td class="summary">
443 <table width="100%" cellpadding="0" cellspacing="0" border="0">
444 <tr>
445 <td><span class="summary-sig"><a name="translate_parameters"></a><span class="summary-sig-name">translate_parameters</span>(<span class="summary-sig-arg">self</span>,
446 <span class="summary-sig-arg">**parameterStatement</span>)</span><br />
447 This will translate the OpenSpeak Case and Params parameters into
448 python equivalent to resultString and returns resultString</td>
449 <td align="right" valign="top">
450 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_parameters">source&nbsp;code</a></span>
451
452 </td>
453 </tr>
454 </table>
455
456 </td>
457 </tr>
458<tr class="private">
459 <td width="15%" align="right" valign="top" class="summary">
460 <span class="summary-type">&nbsp;</span>
461 </td><td class="summary">
462 <table width="100%" cellpadding="0" cellspacing="0" border="0">
463 <tr>
464 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#_argsCheck" class="summary-sig-name" onclick="show_private();">_argsCheck</a>(<span class="summary-sig-arg">self</span>,
465 <span class="summary-sig-arg">**args</span>)</span><br />
466 This API will check if given argument is varibale reference or String
467 and will translate accordingly.</td>
468 <td align="right" valign="top">
469 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak._argsCheck">source&nbsp;code</a></span>
470
471 </td>
472 </tr>
473 </table>
474
475 </td>
476 </tr>
477<tr>
478 <td width="15%" align="right" valign="top" class="summary">
479 <span class="summary-type">&nbsp;</span>
480 </td><td class="summary">
481 <table width="100%" cellpadding="0" cellspacing="0" border="0">
482 <tr>
483 <td><span class="summary-sig"><a name="translate_step"></a><span class="summary-sig-name">translate_step</span>(<span class="summary-sig-arg">self</span>,
484 <span class="summary-sig-arg">**stepStatement</span>)</span><br />
485 This will translate the STEP &quot;DO SOMETHING HERE&quot; into
486 python equivalent to resultString and returns resultString</td>
487 <td align="right" valign="top">
488 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_step">source&nbsp;code</a></span>
489
490 </td>
491 </tr>
492 </table>
493
494 </td>
495 </tr>
496<tr>
497 <td width="15%" align="right" valign="top" class="summary">
498 <span class="summary-type">&nbsp;</span>
499 </td><td class="summary">
500 <table width="100%" cellpadding="0" cellspacing="0" border="0">
501 <tr>
502 <td><span class="summary-sig"><a name="translate_comment"></a><span class="summary-sig-name">translate_comment</span>(<span class="summary-sig-arg">self</span>,
503 <span class="summary-sig-arg">**commentStatement</span>)</span><br />
504 This will translate the COMMENT &quot;DO SOMETHING HERE&quot; into
505 python equivalent to resultString and returns resultString</td>
506 <td align="right" valign="top">
507 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_comment">source&nbsp;code</a></span>
508
509 </td>
510 </tr>
511 </table>
512
513 </td>
514 </tr>
515<tr>
516 <td width="15%" align="right" valign="top" class="summary">
517 <span class="summary-type">&nbsp;</span>
518 </td><td class="summary">
519 <table width="100%" cellpadding="0" cellspacing="0" border="0">
520 <tr>
521 <td><span class="summary-sig"><a name="translate_testcase_name"></a><span class="summary-sig-name">translate_testcase_name</span>(<span class="summary-sig-arg">self</span>,
522 <span class="summary-sig-arg">**nameStatement</span>)</span><br />
523 This method will convert NAME &quot;&lt;Testcase_name&gt;&quot; into
524 python equivalent statement to resultString and returns resultString</td>
525 <td align="right" valign="top">
526 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_testcase_name">source&nbsp;code</a></span>
527
528 </td>
529 </tr>
530 </table>
531
532 </td>
533 </tr>
534<tr>
535 <td width="15%" align="right" valign="top" class="summary">
536 <span class="summary-type">&nbsp;</span>
537 </td><td class="summary">
538 <table width="100%" cellpadding="0" cellspacing="0" border="0">
539 <tr>
540 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_case_block" class="summary-sig-name">translate_case_block</a>(<span class="summary-sig-arg">self</span>,
541 <span class="summary-sig-arg">**caseBlock</span>)</span><br />
542 This method will translate the case block in test script .</td>
543 <td align="right" valign="top">
544 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_case_block">source&nbsp;code</a></span>
545
546 </td>
547 </tr>
548 </table>
549
550 </td>
551 </tr>
552<tr>
553 <td width="15%" align="right" valign="top" class="summary">
554 <span class="summary-type">&nbsp;</span>
555 </td><td class="summary">
556 <table width="100%" cellpadding="0" cellspacing="0" border="0">
557 <tr>
558 <td><span class="summary-sig"><a href="TestON.core.openspeak.OpenSpeak-class.html#translate_loop_block" class="summary-sig-name">translate_loop_block</a>(<span class="summary-sig-arg">self</span>,
559 <span class="summary-sig-arg">*loopBlock</span>)</span><br />
560 This method will translate for loop block into its equivalent python
561 code.</td>
562 <td align="right" valign="top">
563 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_loop_block">source&nbsp;code</a></span>
564
565 </td>
566 </tr>
567 </table>
568
569 </td>
570 </tr>
571<tr>
572 <td width="15%" align="right" valign="top" class="summary">
573 <span class="summary-type">&nbsp;</span>
574 </td><td class="summary">
575 <table width="100%" cellpadding="0" cellspacing="0" border="0">
576 <tr>
577 <td><span class="summary-sig"><a name="translate_conjuction"></a><span class="summary-sig-name">translate_conjuction</span>(<span class="summary-sig-arg">self</span>,
578 <span class="summary-sig-arg">conjuctionStatement</span>)</span><br />
579 This will translate the AND conjuction statements into python
580 equivalent to resultString and returns resultString</td>
581 <td align="right" valign="top">
582 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_conjuction">source&nbsp;code</a></span>
583
584 </td>
585 </tr>
586 </table>
587
588 </td>
589 </tr>
590<tr>
591 <td width="15%" align="right" valign="top" class="summary">
592 <span class="summary-type">&nbsp;</span>
593 </td><td class="summary">
594 <table width="100%" cellpadding="0" cellspacing="0" border="0">
595 <tr>
596 <td><span class="summary-sig"><a name="parse_args"></a><span class="summary-sig-name">parse_args</span>(<span class="summary-sig-arg">self</span>,
597 <span class="summary-sig-arg">args</span>,
598 <span class="summary-sig-arg">**kwargs</span>)</span><br />
599 It will accept the (key,value) pair and will return the (key,value)
600 pairs with keys in uppercase.</td>
601 <td align="right" valign="top">
602 <span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.parse_args">source&nbsp;code</a></span>
603
604 </td>
605 </tr>
606 </table>
607
608 </td>
609 </tr>
610</table>
611<!-- ==================== METHOD DETAILS ==================== -->
612<a name="section-MethodDetails"></a>
613<table class="details" border="1" cellpadding="3"
614 cellspacing="0" width="100%" bgcolor="white">
615<tr bgcolor="#70b0f0" class="table-header">
616 <td colspan="2" class="table-header">
617 <table border="0" cellpadding="0" cellspacing="0" width="100%">
618 <tr valign="top">
619 <td align="left"><span class="table-header">Method Details</span></td>
620 <td align="right" valign="top"
621 ><span class="options">[<a href="#section-MethodDetails"
622 class="privatelink" onclick="toggle_private();"
623 >hide private</a>]</span></td>
624 </tr>
625 </table>
626 </td>
627</tr>
628</table>
629<a name="compiler"></a>
630<div>
631<table class="details" border="1" cellpadding="3"
632 cellspacing="0" width="100%" bgcolor="white">
633<tr><td>
634 <table width="100%" cellpadding="0" cellspacing="0" border="0">
635 <tr valign="top"><td>
636 <h3 class="epydoc"><span class="sig"><span class="sig-name">compiler</span>(<span class="sig-arg">self</span>,
637 <span class="sig-arg">**compileParameters</span>)</span>
638 </h3>
639 </td><td align="right" valign="top"
640 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.compiler">source&nbsp;code</a></span>&nbsp;
641 </td>
642 </tr></table>
643
644 <p>This method will parse the openspeak file and will write to a python
645 module with the equivalent translations. It can accept OpenSpeak syntax
646 in string or an OpenSpeak file as an input parameter. Translated form can
647 be written into python module if attribute &quot;WRITETOFILE&quot; is set
648 to 1.</p>
649 <dl class="fields">
650 </dl>
651</td></tr></table>
652</div>
653<a name="verify_and_translate"></a>
654<div>
655<table class="details" border="1" cellpadding="3"
656 cellspacing="0" width="100%" bgcolor="white">
657<tr><td>
658 <table width="100%" cellpadding="0" cellspacing="0" border="0">
659 <tr valign="top"><td>
660 <h3 class="epydoc"><span class="sig"><span class="sig-name">verify_and_translate</span>(<span class="sig-arg">self</span>,
661 <span class="sig-arg">line</span>)</span>
662 </h3>
663 </td><td align="right" valign="top"
664 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.verify_and_translate">source&nbsp;code</a></span>&nbsp;
665 </td>
666 </tr></table>
667
668 <p>It will accept the each line and calls the suitable API to conver into
669 pyton equivalent syntax . It will return the translated python syntax
670 .</p>
671 <dl class="fields">
672 </dl>
673</td></tr></table>
674</div>
675<a name="translate_if_else_operator"></a>
676<div>
677<table class="details" border="1" cellpadding="3"
678 cellspacing="0" width="100%" bgcolor="white">
679<tr><td>
680 <table width="100%" cellpadding="0" cellspacing="0" border="0">
681 <tr valign="top"><td>
682 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_if_else_operator</span>(<span class="sig-arg">self</span>,
683 <span class="sig-arg">**loopBlock</span>)</span>
684 </h3>
685 </td><td align="right" valign="top"
686 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_if_else_operator">source&nbsp;code</a></span>&nbsp;
687 </td>
688 </tr></table>
689
690 <p>This method will translate if-else loop block into its equivalent
691 python code. Whole loop block will be passed into loopBlock List. It
692 returns the transalted reuslt as a string.</p>
693 <dl class="fields">
694 </dl>
695</td></tr></table>
696</div>
697<a name="translate_experimental_mode"></a>
698<div>
699<table class="details" border="1" cellpadding="3"
700 cellspacing="0" width="100%" bgcolor="white">
701<tr><td>
702 <table width="100%" cellpadding="0" cellspacing="0" border="0">
703 <tr valign="top"><td>
704 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_experimental_mode</span>(<span class="sig-arg">self</span>,
705 <span class="sig-arg">**modeType</span>)</span>
706 </h3>
707 </td><td align="right" valign="top"
708 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_experimental_mode">source&nbsp;code</a></span>&nbsp;
709 </td>
710 </tr></table>
711
712 <p>This API will translate statment EXPERIMENTAL MODE ON/OFF into python
713 equivalent. It will return the transalted value.</p>
714 <dl class="fields">
715 </dl>
716</td></tr></table>
717</div>
718<a name="translate_log_message"></a>
719<div>
720<table class="details" border="1" cellpadding="3"
721 cellspacing="0" width="100%" bgcolor="white">
722<tr><td>
723 <table width="100%" cellpadding="0" cellspacing="0" border="0">
724 <tr valign="top"><td>
725 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_log_message</span>(<span class="sig-arg">self</span>,
726 <span class="sig-arg">**messageStatement</span>)</span>
727 </h3>
728 </td><td align="right" valign="top"
729 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_log_message">source&nbsp;code</a></span>&nbsp;
730 </td>
731 </tr></table>
732
733 <p>This API will translate log messages if it is a string or Variable or
734 combination of string and variable. It will return the analysed and
735 translate message.</p>
736 <dl class="fields">
737 </dl>
738</td></tr></table>
739</div>
740<a name="translate_response_result"></a>
741<div>
742<table class="details" border="1" cellpadding="3"
743 cellspacing="0" width="100%" bgcolor="white">
744<tr><td>
745 <table width="100%" cellpadding="0" cellspacing="0" border="0">
746 <tr valign="top"><td>
747 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_response_result</span>(<span class="sig-arg">self</span>,
748 <span class="sig-arg">**operatorStatement</span>)</span>
749 </h3>
750 </td><td align="right" valign="top"
751 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_response_result">source&nbsp;code</a></span>&nbsp;
752 </td>
753 </tr></table>
754
755 <p>It will translate the LAST_RESPONSE or LAST_RESULT statement into its
756 equivalent. It returns the translate form in resulString.</p>
757 <dl class="fields">
758 </dl>
759</td></tr></table>
760</div>
761<a name="translate_assertMessage"></a>
762<div>
763<table class="details" border="1" cellpadding="3"
764 cellspacing="0" width="100%" bgcolor="white">
765<tr><td>
766 <table width="100%" cellpadding="0" cellspacing="0" border="0">
767 <tr valign="top"><td>
768 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_assertMessage</span>(<span class="sig-arg">self</span>,
769 <span class="sig-arg">**messageStatement</span>)</span>
770 </h3>
771 </td><td align="right" valign="top"
772 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_assertMessage">source&nbsp;code</a></span>&nbsp;
773 </td>
774 </tr></table>
775
776 <p>This API will facilitate the translation of assert ONPASS or ONFAIL
777 messages . The message can be a string or calling another API in
778 OpenSpeak syntax. It will return the translated message</p>
779 <dl class="fields">
780 </dl>
781</td></tr></table>
782</div>
783<a name="translate_operator"></a>
784<div>
785<table class="details" border="1" cellpadding="3"
786 cellspacing="0" width="100%" bgcolor="white">
787<tr><td>
788 <table width="100%" cellpadding="0" cellspacing="0" border="0">
789 <tr valign="top"><td>
790 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_operator</span>(<span class="sig-arg">self</span>,
791 <span class="sig-arg">**operatorStatement</span>)</span>
792 </h3>
793 </td><td align="right" valign="top"
794 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_operator">source&nbsp;code</a></span>&nbsp;
795 </td>
796 </tr></table>
797
798 <p>It will translate the operator for assertion , by ensuring against
799 given arguments. It will return the translated assertion operator.</p>
800 <dl class="fields">
801 </dl>
802</td></tr></table>
803</div>
804<a name="translate_usingas"></a>
805<div>
806<table class="details" border="1" cellpadding="3"
807 cellspacing="0" width="100%" bgcolor="white">
808<tr><td>
809 <table width="100%" cellpadding="0" cellspacing="0" border="0">
810 <tr valign="top"><td>
811 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_usingas</span>(<span class="sig-arg">self</span>,
812 <span class="sig-arg">**argumentAS</span>)</span>
813 </h3>
814 </td><td align="right" valign="top"
815 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_usingas">source&nbsp;code</a></span>&nbsp;
816 </td>
817 </tr></table>
818
819 <p>This will tranlate USING argument AS value Statement into equivalent
820 argument passing. It will return translated form into resultString</p>
821 <dl class="fields">
822 </dl>
823</td></tr></table>
824</div>
825<a name="_argsCheck"></a>
826<div class="private">
827<table class="details" border="1" cellpadding="3"
828 cellspacing="0" width="100%" bgcolor="white">
829<tr><td>
830 <table width="100%" cellpadding="0" cellspacing="0" border="0">
831 <tr valign="top"><td>
832 <h3 class="epydoc"><span class="sig"><span class="sig-name">_argsCheck</span>(<span class="sig-arg">self</span>,
833 <span class="sig-arg">**args</span>)</span>
834 </h3>
835 </td><td align="right" valign="top"
836 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak._argsCheck">source&nbsp;code</a></span>&nbsp;
837 </td>
838 </tr></table>
839
840 <p>This API will check if given argument is varibale reference or String
841 and will translate accordingly. It will return the tanslate form in
842 resultString.</p>
843 <dl class="fields">
844 </dl>
845</td></tr></table>
846</div>
847<a name="translate_case_block"></a>
848<div>
849<table class="details" border="1" cellpadding="3"
850 cellspacing="0" width="100%" bgcolor="white">
851<tr><td>
852 <table width="100%" cellpadding="0" cellspacing="0" border="0">
853 <tr valign="top"><td>
854 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_case_block</span>(<span class="sig-arg">self</span>,
855 <span class="sig-arg">**caseBlock</span>)</span>
856 </h3>
857 </td><td align="right" valign="top"
858 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_case_block">source&nbsp;code</a></span>&nbsp;
859 </td>
860 </tr></table>
861
862 <p>This method will translate the case block in test script . It returns
863 the translated equivalent python code for test script</p>
864 <dl class="fields">
865 </dl>
866</td></tr></table>
867</div>
868<a name="translate_loop_block"></a>
869<div>
870<table class="details" border="1" cellpadding="3"
871 cellspacing="0" width="100%" bgcolor="white">
872<tr><td>
873 <table width="100%" cellpadding="0" cellspacing="0" border="0">
874 <tr valign="top"><td>
875 <h3 class="epydoc"><span class="sig"><span class="sig-name">translate_loop_block</span>(<span class="sig-arg">self</span>,
876 <span class="sig-arg">*loopBlock</span>)</span>
877 </h3>
878 </td><td align="right" valign="top"
879 ><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_loop_block">source&nbsp;code</a></span>&nbsp;
880 </td>
881 </tr></table>
882
883 <p>This method will translate for loop block into its equivalent python
884 code. Whole loop block will be passed into loopBlock List. It returns the
885 transalted reuslt as a string.</p>
886 <dl class="fields">
887 </dl>
888</td></tr></table>
889</div>
890<br />
891<!-- ==================== NAVIGATION BAR ==================== -->
892<table class="navbar" border="0" width="100%" cellpadding="0"
893 bgcolor="#a0c0ff" cellspacing="0">
894 <tr valign="middle">
895 <!-- Home link -->
896 <th>&nbsp;&nbsp;&nbsp;<a
897 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
898
899 <!-- Tree link -->
900 <th>&nbsp;&nbsp;&nbsp;<a
901 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
902
903 <!-- Index link -->
904 <th>&nbsp;&nbsp;&nbsp;<a
905 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
906
907 <!-- Help link -->
908 <th>&nbsp;&nbsp;&nbsp;<a
909 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
910
911 <th class="navbar" width="100%"></th>
912 </tr>
913</table>
914<table border="0" cellpadding="0" cellspacing="0" width="100%%">
915 <tr>
916 <td align="left" class="footer">
917 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
918 </td>
919 <td align="right" class="footer">
920 <a target="mainFrame" href="http://epydoc.sourceforge.net"
921 >http://epydoc.sourceforge.net</a>
922 </td>
923 </tr>
924</table>
925
926<script type="text/javascript">
927 <!--
928 // Private objects are initially displayed (because if
929 // javascript is turned off then we want them to be
930 // visible); but by default, we want to hide them. So hide
931 // them unless we have a cookie that says to show them.
932 checkCookie();
933 // -->
934</script>
935</body>
936</html>