Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / fd191203c317bf828475fd02dca8dfcac6e7d4e4 / . / TestON / Documentation / TestON_Document / TestON.core.openspeak.OpenSpeak-class.html
blob: 440bdb53b0d62f9bee60034e399d4a161ff83d21 [file] [log] [blame]
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>TestON.core.openspeak.OpenSpeak</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="TestON-module.html">Package&nbsp;TestON</a> ::
<a href="TestON.core-module.html">Package&nbsp;core</a> ::
<a href="TestON.core.openspeak-module.html">Module&nbsp;openspeak</a> ::
Class&nbsp;OpenSpeak
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>]&nbsp;|&nbsp;<a href="TestON.core.openspeak.OpenSpeak-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<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>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.__init__">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**compileParameters</span>)</span><br />
This method will parse the openspeak file and will write to a python
module with the equivalent translations.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.compiler">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">line</span>)</span><br />
It will accept the each line and calls the suitable API to conver
into pyton equivalent syntax .</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.verify_and_translate">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**repeatStatement</span>)</span><br />
this will transalte the repeat statement into a python equivalen
while loop</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_repeat">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**loopBlock</span>)</span><br />
This method will translate if-else loop block into its equivalent
python code.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_if_else_operator">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**modeType</span>)</span><br />
This API will translate statment EXPERIMENTAL MODE ON/OFF into python
equivalent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_experimental_mode">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="interpret"></a><span class="summary-sig-name">interpret</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**interpetParameters</span>)</span><br />
This method will accept the OpenSpeak syntax into a string and will
return a python equivalent translations statement</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.interpret">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**logStatement</span>)</span><br />
This will translate the OpenSpeak log message statements into python
equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_logs">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**messageStatement</span>)</span><br />
This API will translate log messages if it is a string or Variable or
combination of string and variable.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_log_message">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**assertStatement</span>)</span><br />
This will translate the ASSERT &lt;value1&gt; &lt;COMPARISON
OPERATOR&gt; &lt;value2&gt; into python equivalent to resultString
and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_assertion">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**operatorStatement</span>)</span><br />
It will translate the LAST_RESPONSE or LAST_RESULT statement into its
equivalent.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_response_result">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**messageStatement</span>)</span><br />
This API will facilitate the translation of assert ONPASS or ONFAIL
messages .</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_assertMessage">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**operatorStatement</span>)</span><br />
It will translate the operator for assertion , by ensuring against
given arguments.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_operator">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**storeStatement</span>)</span><br />
This will translate the STORE &lt;variable&gt; IN &lt;value&gt; or
&lt;variable&gt; = &lt;value&gt; into python equivalent to
resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_store">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**disconnectStatement</span>)</span><br />
This will translate the DISCONNECT &lt;component_name&gt; into python
equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_disconnect">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**onDoStatement</span>)</span><br />
This will translate the ON &lt;component&gt; DO &lt;action&gt; USING
&lt;arg1&gt; AS &lt;value1&gt;,&lt;arg2&gt; AS &lt;value2&gt; into
python equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_onDOAs">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**conjuctStatement</span>)</span><br />
This will handle the conjuctions</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.handle_conjuction">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**argumentAS</span>)</span><br />
This will tranlate USING argument AS value Statement into equivalent
argument passing.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_usingas">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**connectStatement</span>)</span><br />
This will translate the CONNECT &lt;component_name&gt; USING1
&lt;arg1&gt; AS &lt;value1&gt;, &lt;arg2&gt; AS &lt;value2&gt; into
python equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_connect">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**parameterStatement</span>)</span><br />
This will translate the OpenSpeak Case and Params parameters into
python equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_parameters">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**args</span>)</span><br />
This API will check if given argument is varibale reference or String
and will translate accordingly.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak._argsCheck">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**stepStatement</span>)</span><br />
This will translate the STEP &quot;DO SOMETHING HERE&quot; into
python equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_step">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**commentStatement</span>)</span><br />
This will translate the COMMENT &quot;DO SOMETHING HERE&quot; into
python equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_comment">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**nameStatement</span>)</span><br />
This method will convert NAME &quot;&lt;Testcase_name&gt;&quot; into
python equivalent statement to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_testcase_name">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">**caseBlock</span>)</span><br />
This method will translate the case block in test script .</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_case_block">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">*loopBlock</span>)</span><br />
This method will translate for loop block into its equivalent python
code.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_loop_block">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">conjuctionStatement</span>)</span><br />
This will translate the AND conjuction statements into python
equivalent to resultString and returns resultString</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_conjuction">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
It will accept the (key,value) pair and will return the (key,value)
pairs with keys in uppercase.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.parse_args">source&nbsp;code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="compiler"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">compiler</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**compileParameters</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.compiler">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This method will parse the openspeak file and will write to a python
module with the equivalent translations. It can accept OpenSpeak syntax
in string or an OpenSpeak file as an input parameter. Translated form can
be written into python module if attribute &quot;WRITETOFILE&quot; is set
to 1.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="verify_and_translate"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">verify_and_translate</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">line</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.verify_and_translate">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>It will accept the each line and calls the suitable API to conver into
pyton equivalent syntax . It will return the translated python syntax
.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_if_else_operator"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_if_else_operator</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**loopBlock</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_if_else_operator">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This method will translate if-else loop block into its equivalent
python code. Whole loop block will be passed into loopBlock List. It
returns the transalted reuslt as a string.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_experimental_mode"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_experimental_mode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**modeType</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_experimental_mode">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This API will translate statment EXPERIMENTAL MODE ON/OFF into python
equivalent. It will return the transalted value.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_log_message"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_log_message</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**messageStatement</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_log_message">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This API will translate log messages if it is a string or Variable or
combination of string and variable. It will return the analysed and
translate message.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_response_result"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_response_result</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**operatorStatement</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_response_result">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>It will translate the LAST_RESPONSE or LAST_RESULT statement into its
equivalent. It returns the translate form in resulString.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_assertMessage"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_assertMessage</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**messageStatement</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_assertMessage">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This API will facilitate the translation of assert ONPASS or ONFAIL
messages . The message can be a string or calling another API in
OpenSpeak syntax. It will return the translated message</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_operator"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_operator</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**operatorStatement</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_operator">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>It will translate the operator for assertion , by ensuring against
given arguments. It will return the translated assertion operator.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_usingas"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_usingas</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**argumentAS</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_usingas">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This will tranlate USING argument AS value Statement into equivalent
argument passing. It will return translated form into resultString</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_argsCheck"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">_argsCheck</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**args</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak._argsCheck">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This API will check if given argument is varibale reference or String
and will translate accordingly. It will return the tanslate form in
resultString.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_case_block"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_case_block</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**caseBlock</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_case_block">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This method will translate the case block in test script . It returns
the translated equivalent python code for test script</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="translate_loop_block"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">translate_loop_block</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">*loopBlock</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.core.openspeak-pysrc.html#OpenSpeak.translate_loop_block">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This method will translate for loop block into its equivalent python
code. Whole loop block will be passed into loopBlock List. It returns the
transalted reuslt as a string.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Tree link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Index link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
<!-- Help link -->
<th>&nbsp;&nbsp;&nbsp;<a
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>