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