Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 1f5e65f85a357a70966bedba2f8c3d011213eeb6 / . / TestON / Documentation / TestON_Document / TestON.bin.updatedriver.UpdateDriver-class.html
blob: 1ef06b132b3b0dd488ea259177c40f253a52491a [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.bin.updatedriver.UpdateDriver</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.bin-module.html">Package&nbsp;bin</a> ::
47 <a href="TestON.bin.updatedriver-module.html">Module&nbsp;updatedriver</a> ::
48 Class&nbsp;UpdateDriver
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.bin.updatedriver.UpdateDriver-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 UpdateDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver">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.bin.updatedriver-pysrc.html#UpdateDriver.__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.bin.updatedriver.UpdateDriver-class.html#getmethods" class="summary-sig-name">getmethods</a>(<span class="summary-sig-arg">self</span>,
106 <span class="summary-sig-arg">modulePath</span>,
107 <span class="summary-sig-arg">Class</span>)</span><br />
108 This will get the list of methods in given module or class.</td>
109 <td align="right" valign="top">
110 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getmethods">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 name="echo"></a><span class="summary-sig-name">echo</span>(<span class="summary-sig-arg">self</span>)</span></td>
125 <td align="right" valign="top">
126 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.echo">source&nbsp;code</a></span>
127
128 </td>
129 </tr>
130 </table>
131
132 </td>
133 </tr>
134<tr>
135 <td width="15%" align="right" valign="top" class="summary">
136 <span class="summary-type">&nbsp;</span>
137 </td><td class="summary">
138 <table width="100%" cellpadding="0" cellspacing="0" border="0">
139 <tr>
140 <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>,
141 <span class="summary-sig-arg">moduleName</span>,
142 <span class="summary-sig-arg">className</span>,
143 <span class="summary-sig-arg">method</span>)</span><br />
144 This will return the list of arguments in a method of python module
145 of class.</td>
146 <td align="right" valign="top">
147 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getargs">source&nbsp;code</a></span>
148
149 </td>
150 </tr>
151 </table>
152
153 </td>
154 </tr>
155<tr>
156 <td width="15%" align="right" valign="top" class="summary">
157 <span class="summary-type">&nbsp;</span>
158 </td><td class="summary">
159 <table width="100%" cellpadding="0" cellspacing="0" border="0">
160 <tr>
161 <td><span class="summary-sig"><a name="configparser"></a><span class="summary-sig-name">configparser</span>(<span class="summary-sig-arg">self</span>,
162 <span class="summary-sig-arg">fileName</span>)</span><br />
163 It will parse the config file (ofa.cfg) and return as dictionary</td>
164 <td align="right" valign="top">
165 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.configparser">source&nbsp;code</a></span>
166
167 </td>
168 </tr>
169 </table>
170
171 </td>
172 </tr>
173<tr>
174 <td width="15%" align="right" valign="top" class="summary">
175 <span class="summary-type">&nbsp;</span>
176 </td><td class="summary">
177 <table width="100%" cellpadding="0" cellspacing="0" border="0">
178 <tr>
179 <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 />
180 This method will maintain the hash with
181 module-&gt;class-&gt;methodList or module -&gt; methodList .It will
182 return the same Hash.</td>
183 <td align="right" valign="top">
184 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getList">source&nbsp;code</a></span>
185
186 </td>
187 </tr>
188 </table>
189
190 </td>
191 </tr>
192<tr>
193 <td width="15%" align="right" valign="top" class="summary">
194 <span class="summary-type">&nbsp;</span>
195 </td><td class="summary">
196 <table width="100%" cellpadding="0" cellspacing="0" border="0">
197 <tr>
198 <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>,
199 <span class="summary-sig-arg">module</span>)</span><br />
200 It removes the ignored classes for each module mention in
201 ofadriver.cfg</td>
202 <td align="right" valign="top">
203 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.class_ignoreList">source&nbsp;code</a></span>
204
205 </td>
206 </tr>
207 </table>
208
209 </td>
210 </tr>
211<tr>
212 <td width="15%" align="right" valign="top" class="summary">
213 <span class="summary-type">&nbsp;</span>
214 </td><td class="summary">
215 <table width="100%" cellpadding="0" cellspacing="0" border="0">
216 <tr>
217 <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>,
218 <span class="summary-sig-arg">module</span>,
219 <span class="summary-sig-arg">className</span>)</span><br />
220 It removes the ignored methods of each module or class mentioned in
221 ofadriver.cfg.</td>
222 <td align="right" valign="top">
223 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.method_ignoreList">source&nbsp;code</a></span>
224
225 </td>
226 </tr>
227 </table>
228
229 </td>
230 </tr>
231<tr>
232 <td width="15%" align="right" valign="top" class="summary">
233 <span class="summary-type">&nbsp;</span>
234 </td><td class="summary">
235 <table width="100%" cellpadding="0" cellspacing="0" border="0">
236 <tr>
237 <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>,
238 <span class="summary-sig-arg">module</span>,
239 <span class="summary-sig-arg">className</span>)</span><br />
240 This will add the methods(mentioned in ofadriver.cfg file) into
241 method list if it doesnot exists in list.</td>
242 <td align="right" valign="top">
243 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.add_method">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="getMethodArgsHash"></a><span class="summary-sig-name">getMethodArgsHash</span>(<span class="summary-sig-arg">self</span>,
258 <span class="summary-sig-arg">moduleName</span>,
259 <span class="summary-sig-arg">module</span>,
260 <span class="summary-sig-arg">className</span>)</span><br />
261 This will maintain a Hash of class-&gt;method-&gt;argumentsList</td>
262 <td align="right" valign="top">
263 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getMethodArgsHash">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 name="appendDriver"></a><span class="summary-sig-name">appendDriver</span>(<span class="summary-sig-arg">self</span>,
278 <span class="summary-sig-arg">fileName</span>)</span><br />
279 This will append the given driver file with methods along with
280 arguments.</td>
281 <td align="right" valign="top">
282 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.appendDriver">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 name="writeDriver"></a><span class="summary-sig-name">writeDriver</span>(<span class="summary-sig-arg">self</span>,
297 <span class="summary-sig-arg">driver</span>)</span><br />
298 This will accept the List of driver name and write those drivers if
299 no driver name is specified then it will write all of the driver
300 specified in the ofadriver.cfg.</td>
301 <td align="right" valign="top">
302 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.writeDriver">source&nbsp;code</a></span>
303
304 </td>
305 </tr>
306 </table>
307
308 </td>
309 </tr>
310<tr>
311 <td width="15%" align="right" valign="top" class="summary">
312 <span class="summary-type">&nbsp;</span>
313 </td><td class="summary">
314 <table width="100%" cellpadding="0" cellspacing="0" border="0">
315 <tr>
316 <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 />
317 It will set the driver path and returns it.If driver path is not
318 specified then it will take default path (/lib/updatedriver/).</td>
319 <td align="right" valign="top">
320 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getDriverPath">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="printHeader"></a><span class="summary-sig-name">printHeader</span>(<span class="summary-sig-arg">self</span>,
335 <span class="summary-sig-arg">driver</span>)</span></td>
336 <td align="right" valign="top">
337 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.printHeader">source&nbsp;code</a></span>
338
339 </td>
340 </tr>
341 </table>
342
343 </td>
344 </tr>
345</table>
346<!-- ==================== METHOD DETAILS ==================== -->
347<a name="section-MethodDetails"></a>
348<table class="details" border="1" cellpadding="3"
349 cellspacing="0" width="100%" bgcolor="white">
350<tr bgcolor="#70b0f0" class="table-header">
351 <td colspan="2" class="table-header">
352 <table border="0" cellpadding="0" cellspacing="0" width="100%">
353 <tr valign="top">
354 <td align="left"><span class="table-header">Method Details</span></td>
355 <td align="right" valign="top"
356 ><span class="options">[<a href="#section-MethodDetails"
357 class="privatelink" onclick="toggle_private();"
358 >hide private</a>]</span></td>
359 </tr>
360 </table>
361 </td>
362</tr>
363</table>
364<a name="getmethods"></a>
365<div>
366<table class="details" border="1" cellpadding="3"
367 cellspacing="0" width="100%" bgcolor="white">
368<tr><td>
369 <table width="100%" cellpadding="0" cellspacing="0" border="0">
370 <tr valign="top"><td>
371 <h3 class="epydoc"><span class="sig"><span class="sig-name">getmethods</span>(<span class="sig-arg">self</span>,
372 <span class="sig-arg">modulePath</span>,
373 <span class="sig-arg">Class</span>)</span>
374 </h3>
375 </td><td align="right" valign="top"
376 ><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getmethods">source&nbsp;code</a></span>&nbsp;
377 </td>
378 </tr></table>
379
380 <p>This will get the list of methods in given module or class. It accepts
381 the module path and class name. If there is no class name then it has be
382 mentioned as None.</p>
383 <dl class="fields">
384 </dl>
385</td></tr></table>
386</div>
387<a name="getargs"></a>
388<div>
389<table class="details" border="1" cellpadding="3"
390 cellspacing="0" width="100%" bgcolor="white">
391<tr><td>
392 <table width="100%" cellpadding="0" cellspacing="0" border="0">
393 <tr valign="top"><td>
394 <h3 class="epydoc"><span class="sig"><span class="sig-name">getargs</span>(<span class="sig-arg">self</span>,
395 <span class="sig-arg">moduleName</span>,
396 <span class="sig-arg">className</span>,
397 <span class="sig-arg">method</span>)</span>
398 </h3>
399 </td><td align="right" valign="top"
400 ><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getargs">source&nbsp;code</a></span>&nbsp;
401 </td>
402 </tr></table>
403
404 <p>This will return the list of arguments in a method of python module of
405 class. It accepts method list as an argument.</p>
406 <dl class="fields">
407 </dl>
408</td></tr></table>
409</div>
410<br />
411<!-- ==================== NAVIGATION BAR ==================== -->
412<table class="navbar" border="0" width="100%" cellpadding="0"
413 bgcolor="#a0c0ff" cellspacing="0">
414 <tr valign="middle">
415 <!-- Home link -->
416 <th>&nbsp;&nbsp;&nbsp;<a
417 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
418
419 <!-- Tree link -->
420 <th>&nbsp;&nbsp;&nbsp;<a
421 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
422
423 <!-- Index link -->
424 <th>&nbsp;&nbsp;&nbsp;<a
425 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
426
427 <!-- Help link -->
428 <th>&nbsp;&nbsp;&nbsp;<a
429 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
430
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]431 <!-- Project homepage -->
432 <th class="navbar" align="right" width="100%">
433 <table border="0" cellpadding="0" cellspacing="0">
434 <tr><th class="navbar" align="center"
435 >TestON</th>
436 </tr></table></th>
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]437 </tr>
438</table>
439<table border="0" cellpadding="0" cellspacing="0" width="100%%">
440 <tr>
441 <td align="left" class="footer">
Jon Halla1cdd892015-08-10 13:36:28 -0700[diff] [blame]442 Generated by Epydoc 3.0.1 on Mon Aug 10 11:12:34 2015
adminbae64d82013-08-01 10:50:15 -0700[diff] [blame]443 </td>
444 <td align="right" class="footer">
445 <a target="mainFrame" href="http://epydoc.sourceforge.net"
446 >http://epydoc.sourceforge.net</a>
447 </td>
448 </tr>
449</table>
450
451<script type="text/javascript">
452 <!--
453 // Private objects are initially displayed (because if
454 // javascript is turned off then we want them to be
455 // visible); but by default, we want to hide them. So hide
456 // them unless we have a cookie that says to show them.
457 checkCookie();
458 // -->
459</script>
460</body>
461</html>