Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 1ab833b49f1be189873c98006ffa6a30cee84fd0 / . / TestON / Documentation / TestON_Document / TestON.bin.updatedriver.UpdateDriver-class.html
blob: 1ef06b132b3b0dd488ea259177c40f253a52491a [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.bin.updatedriver.UpdateDriver</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>
<!-- 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">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="TestON-module.html">Package&nbsp;TestON</a> ::
<a href="TestON.bin-module.html">Package&nbsp;bin</a> ::
<a href="TestON.bin.updatedriver-module.html">Module&nbsp;updatedriver</a> ::
Class&nbsp;UpdateDriver
</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.bin.updatedriver.UpdateDriver-class.html"
target="_top">no&nbsp;frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class UpdateDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver">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.bin.updatedriver-pysrc.html#UpdateDriver.__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.bin.updatedriver.UpdateDriver-class.html#getmethods" class="summary-sig-name">getmethods</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">modulePath</span>,
<span class="summary-sig-arg">Class</span>)</span><br />
This will get the list of methods in given module or class.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getmethods">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="echo"></a><span class="summary-sig-name">echo</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.echo">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.bin.updatedriver.UpdateDriver-class.html#getargs" class="summary-sig-name">getargs</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">moduleName</span>,
<span class="summary-sig-arg">className</span>,
<span class="summary-sig-arg">method</span>)</span><br />
This will return the list of arguments in a method of python module
of class.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getargs">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="configparser"></a><span class="summary-sig-name">configparser</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fileName</span>)</span><br />
It will parse the config file (ofa.cfg) and return as dictionary</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.configparser">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="getList"></a><span class="summary-sig-name">getList</span>(<span class="summary-sig-arg">self</span>)</span><br />
This method will maintain the hash with
module-&gt;class-&gt;methodList or module -&gt; methodList .It will
return the same Hash.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getList">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="class_ignoreList"></a><span class="summary-sig-name">class_ignoreList</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">module</span>)</span><br />
It removes the ignored classes for each module mention in
ofadriver.cfg</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.class_ignoreList">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="method_ignoreList"></a><span class="summary-sig-name">method_ignoreList</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">module</span>,
<span class="summary-sig-arg">className</span>)</span><br />
It removes the ignored methods of each module or class mentioned in
ofadriver.cfg.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.method_ignoreList">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="add_method"></a><span class="summary-sig-name">add_method</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">module</span>,
<span class="summary-sig-arg">className</span>)</span><br />
This will add the methods(mentioned in ofadriver.cfg file) into
method list if it doesnot exists in list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.add_method">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="getMethodArgsHash"></a><span class="summary-sig-name">getMethodArgsHash</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">moduleName</span>,
<span class="summary-sig-arg">module</span>,
<span class="summary-sig-arg">className</span>)</span><br />
This will maintain a Hash of class-&gt;method-&gt;argumentsList</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getMethodArgsHash">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="appendDriver"></a><span class="summary-sig-name">appendDriver</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fileName</span>)</span><br />
This will append the given driver file with methods along with
arguments.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.appendDriver">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="writeDriver"></a><span class="summary-sig-name">writeDriver</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">driver</span>)</span><br />
This will accept the List of driver name and write those drivers if
no driver name is specified then it will write all of the driver
specified in the ofadriver.cfg.</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.writeDriver">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="getDriverPath"></a><span class="summary-sig-name">getDriverPath</span>(<span class="summary-sig-arg">self</span>)</span><br />
It will set the driver path and returns it.If driver path is not
specified then it will take default path (/lib/updatedriver/).</td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getDriverPath">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="printHeader"></a><span class="summary-sig-name">printHeader</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">driver</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.printHeader">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="getmethods"></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">getmethods</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">modulePath</span>,
<span class="sig-arg">Class</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getmethods">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This will get the list of methods in given module or class. It accepts
the module path and class name. If there is no class name then it has be
mentioned as None.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="getargs"></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">getargs</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">moduleName</span>,
<span class="sig-arg">className</span>,
<span class="sig-arg">method</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getargs">source&nbsp;code</a></span>&nbsp;
</td>
</tr></table>
<p>This will return the list of arguments in a method of python module of
class. It accepts method list as an argument.</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>
<!-- 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 Aug 10 11:12:34 2015
</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>