Update api docs
Change-Id: I44f59a4b066929dcbd5d8f07df87d0d600a4aca8
diff --git a/TestON/Documentation/TestON_Document/TestON.drivers.common.cli.toolsdriver.Tools-class.html b/TestON/Documentation/TestON_Document/TestON.drivers.common.cli.toolsdriver.Tools-class.html
index 28c03f5..6a30269 100644
--- a/TestON/Documentation/TestON_Document/TestON.drivers.common.cli.toolsdriver.Tools-class.html
+++ b/TestON/Documentation/TestON_Document/TestON.drivers.common.cli.toolsdriver.Tools-class.html
@@ -30,7 +30,12 @@
<th> <a
href="help.html">Help</a> </th>
- <th class="navbar" width="100%"></th>
+ <!-- Project homepage -->
+ <th class="navbar" align="right" width="100%">
+ <table border="0" cellpadding="0" cellspacing="0">
+ <tr><th class="navbar" align="center"
+ >TestON</th>
+ </tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
@@ -60,16 +65,15 @@
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Tools</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.toolsdriver-pysrc.html#Tools">source code</a></span></p>
-<pre class="base-tree">
- object --+
- |
-<a href="TestON.drivers.component.Component-class.html">component.Component</a> --+
- |
- <a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a> --+
- |
- <strong class="uidshort">Tools</strong>
-</pre>
-
+<center>
+<center> <map id="class_hierarchy_for_tools" name="class_hierarchy_for_tools">
+<area shape="rect" id="node1" href="TestON.drivers.common.cli.toolsdriver.Tools-class.html" title="Tools" alt="" coords="5,6,59,31"/>
+<area shape="rect" id="node2" href="TestON.drivers.common.clidriver.CLI-class.html" title="clidriver.CLI" alt="" coords="83,6,175,31"/>
+<area shape="rect" id="node3" href="javascript:void(0);" title="component.Component" alt="" coords="200,6,357,31"/>
+</map>
+ <img src="class_hierarchy_for_tools.gif" alt='' usemap="#class_hierarchy_for_tools" ismap="ismap" class="graph-without-title" />
+</center>
+</center>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
@@ -95,7 +99,7 @@
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="TestON.drivers.common.cli.toolsdriver.Tools-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
- x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
+ x.__init__(...) initializes x; see help(type(x)) for signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.drivers.common.cli.toolsdriver-pysrc.html#Tools.__init__">source code</a></span>
@@ -105,24 +109,149 @@
</td>
</tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">**connectargs</span>)</span><br />
+ Connection will establish to the remote host using ssh.
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.connect">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span>
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.disconnect">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">**execparams</span>)</span><br />
+ It facilitates the command line execution of a given command.
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.execute">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="onfail"></a><span class="summary-sig-name">onfail</span>(<span class="summary-sig-arg">self</span>)</span>
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.onfail">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="remove_contol_chars"></a><span class="summary-sig-name">remove_contol_chars</span>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">response</span>)</span>
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.remove_contol_chars">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a name="runAsSudoUser"></a><span class="summary-sig-name">runAsSudoUser</span>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">handle</span>,
+ <span class="summary-sig-arg">pwd</span>,
+ <span class="summary-sig-arg">default</span>)</span>
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.runAsSudoUser">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
+<tr>
+ <td width="15%" align="right" valign="top" class="summary">
+ <span class="summary-type"> </span>
+ </td><td class="summary">
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td><span class="summary-sig"><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy" class="summary-sig-name">secureCopy</a>(<span class="summary-sig-arg">self</span>,
+ <span class="summary-sig-arg">user_name</span>,
+ <span class="summary-sig-arg">ip_address</span>,
+ <span class="summary-sig-arg">filepath</span>,
+ <span class="summary-sig-arg">pwd</span>,
+ <span class="summary-sig-arg">dst_path</span>)</span><br />
+ Connection will establish to the remote host using ssh.
+ <em>(Inherited from <a href="TestON.drivers.common.clidriver.CLI-class.html">TestON.drivers.common.clidriver.CLI</a>)</em></td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="TestON.drivers.common.clidriver-pysrc.html#CLI.secureCopy">source code</a></span>
+
+ </td>
+ </tr>
+ </table>
+
+ </td>
+ </tr>
<tr>
<td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a></code></b>:
- <code><a href="TestON.drivers.common.clidriver.CLI-class.html#connect">connect</a></code>,
- <code><a href="TestON.drivers.common.clidriver.CLI-class.html#disconnect">disconnect</a></code>,
- <code><a href="TestON.drivers.common.clidriver.CLI-class.html#execute">execute</a></code>,
- <code><a href="TestON.drivers.common.clidriver.CLI-class.html#onfail">onfail</a></code>,
- <code><a href="TestON.drivers.common.clidriver.CLI-class.html#runAsSudoUser">runAsSudoUser</a></code>,
- <code><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy">secureCopy</a></code>
- </p>
- <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.component.Component-class.html">component.Component</a></code></b>:
- <code><a href="TestON.drivers.component.Component-class.html#__getattr__">__getattr__</a></code>,
- <code><a href="TestON.drivers.component.Component-class.html#cleanup">cleanup</a></code>,
- <code><a href="TestON.drivers.component.Component-class.html#close_log_handles">close_log_handles</a></code>,
- <code><a href="TestON.drivers.component.Component-class.html#config">config</a></code>,
- <code><a href="TestON.drivers.component.Component-class.html#experimentRun">experimentRun</a></code>,
- <code><a href="TestON.drivers.component.Component-class.html#get_version">get_version</a></code>,
- <code><a href="TestON.drivers.component.Component-class.html#log">log</a></code>
+ <p class="indent-wrapped-lines"><b>Inherited from <code>component.Component</code></b>:
+ <code>__getattr__</code>,
+ <code>cleanup</code>,
+ <code>close_log_handles</code>,
+ <code>config</code>,
+ <code>experimentRun</code>,
+ <code>get_version</code>,
+ <code>log</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
@@ -199,8 +328,7 @@
</td>
</tr></table>
- <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
- signature</p>
+ <p>x.__init__(...) initializes x; see help(type(x)) for signature</p>
<dl class="fields">
<dt>Overrides:
object.__init__
@@ -230,13 +358,18 @@
<th> <a
href="help.html">Help</a> </th>
- <th class="navbar" width="100%"></th>
+ <!-- Project homepage -->
+ <th class="navbar" align="right" width="100%">
+ <table border="0" cellpadding="0" cellspacing="0">
+ <tr><th class="navbar" align="center"
+ >TestON</th>
+ </tr></table></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
+ Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:35 2015
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"