Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / bae64d8d1b35c6e0c4f600e55a39f319c009ad05 / . / TestON / Documentation / TestON_Document / TestON.bin.updatedriver.UpdateDriver-class.html
blob: 8f08124d1f918cc25b39034084962bf58f047628 [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
33 <th class="navbar" width="100%"></th>
34 </tr>
35</table>
36<table width="100%" cellpadding="0" cellspacing="0">
37 <tr valign="top">
38 <td width="100%">
39 <span class="breadcrumbs">
40 <a href="TestON-module.html">Package&nbsp;TestON</a> ::
41 <a href="TestON.bin-module.html">Package&nbsp;bin</a> ::
42 <a href="TestON.bin.updatedriver-module.html">Module&nbsp;updatedriver</a> ::
43 Class&nbsp;UpdateDriver
44 </span>
45 </td>
46 <td>
47 <table cellpadding="0" cellspacing="0">
48 <!-- hide/show private -->
49 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
50 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
51 <tr><td align="right"><span class="options"
52 >[<a href="frames.html" target="_top">frames</a
53 >]&nbsp;|&nbsp;<a href="TestON.bin.updatedriver.UpdateDriver-class.html"
54 target="_top">no&nbsp;frames</a>]</span></td></tr>
55 </table>
56 </td>
57 </tr>
58</table>
59<!-- ==================== CLASS DESCRIPTION ==================== -->
60<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>
61<!-- ==================== INSTANCE METHODS ==================== -->
62<a name="section-InstanceMethods"></a>
63<table class="summary" border="1" cellpadding="3"
64 cellspacing="0" width="100%" bgcolor="white">
65<tr bgcolor="#70b0f0" class="table-header">
66 <td colspan="2" class="table-header">
67 <table border="0" cellpadding="0" cellspacing="0" width="100%">
68 <tr valign="top">
69 <td align="left"><span class="table-header">Instance Methods</span></td>
70 <td align="right" valign="top"
71 ><span class="options">[<a href="#section-InstanceMethods"
72 class="privatelink" onclick="toggle_private();"
73 >hide private</a>]</span></td>
74 </tr>
75 </table>
76 </td>
77</tr>
78<tr>
79 <td width="15%" align="right" valign="top" class="summary">
80 <span class="summary-type">&nbsp;</span>
81 </td><td class="summary">
82 <table width="100%" cellpadding="0" cellspacing="0" border="0">
83 <tr>
84 <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>
85 <td align="right" valign="top">
86 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.__init__">source&nbsp;code</a></span>
87
88 </td>
89 </tr>
90 </table>
91
92 </td>
93 </tr>
94<tr>
95 <td width="15%" align="right" valign="top" class="summary">
96 <span class="summary-type">&nbsp;</span>
97 </td><td class="summary">
98 <table width="100%" cellpadding="0" cellspacing="0" border="0">
99 <tr>
100 <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>,
101 <span class="summary-sig-arg">modulePath</span>,
102 <span class="summary-sig-arg">Class</span>)</span><br />
103 This will get the list of methods in given module or class.</td>
104 <td align="right" valign="top">
105 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getmethods">source&nbsp;code</a></span>
106
107 </td>
108 </tr>
109 </table>
110
111 </td>
112 </tr>
113<tr>
114 <td width="15%" align="right" valign="top" class="summary">
115 <span class="summary-type">&nbsp;</span>
116 </td><td class="summary">
117 <table width="100%" cellpadding="0" cellspacing="0" border="0">
118 <tr>
119 <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>
120 <td align="right" valign="top">
121 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.echo">source&nbsp;code</a></span>
122
123 </td>
124 </tr>
125 </table>
126
127 </td>
128 </tr>
129<tr>
130 <td width="15%" align="right" valign="top" class="summary">
131 <span class="summary-type">&nbsp;</span>
132 </td><td class="summary">
133 <table width="100%" cellpadding="0" cellspacing="0" border="0">
134 <tr>
135 <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>,
136 <span class="summary-sig-arg">moduleName</span>,
137 <span class="summary-sig-arg">className</span>,
138 <span class="summary-sig-arg">method</span>)</span><br />
139 This will return the list of arguments in a method of python module
140 of class.</td>
141 <td align="right" valign="top">
142 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getargs">source&nbsp;code</a></span>
143
144 </td>
145 </tr>
146 </table>
147
148 </td>
149 </tr>
150<tr>
151 <td width="15%" align="right" valign="top" class="summary">
152 <span class="summary-type">&nbsp;</span>
153 </td><td class="summary">
154 <table width="100%" cellpadding="0" cellspacing="0" border="0">
155 <tr>
156 <td><span class="summary-sig"><a name="configparser"></a><span class="summary-sig-name">configparser</span>(<span class="summary-sig-arg">self</span>,
157 <span class="summary-sig-arg">fileName</span>)</span><br />
158 It will parse the config file (ofa.cfg) and return as dictionary</td>
159 <td align="right" valign="top">
160 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.configparser">source&nbsp;code</a></span>
161
162 </td>
163 </tr>
164 </table>
165
166 </td>
167 </tr>
168<tr>
169 <td width="15%" align="right" valign="top" class="summary">
170 <span class="summary-type">&nbsp;</span>
171 </td><td class="summary">
172 <table width="100%" cellpadding="0" cellspacing="0" border="0">
173 <tr>
174 <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 />
175 This method will maintain the hash with
176 module-&gt;class-&gt;methodList or module -&gt; methodList .It will
177 return the same Hash.</td>
178 <td align="right" valign="top">
179 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getList">source&nbsp;code</a></span>
180
181 </td>
182 </tr>
183 </table>
184
185 </td>
186 </tr>
187<tr>
188 <td width="15%" align="right" valign="top" class="summary">
189 <span class="summary-type">&nbsp;</span>
190 </td><td class="summary">
191 <table width="100%" cellpadding="0" cellspacing="0" border="0">
192 <tr>
193 <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>,
194 <span class="summary-sig-arg">module</span>)</span><br />
195 It removes the ignored classes for each module mention in
196 ofadriver.cfg</td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.class_ignoreList">source&nbsp;code</a></span>
199
200 </td>
201 </tr>
202 </table>
203
204 </td>
205 </tr>
206<tr>
207 <td width="15%" align="right" valign="top" class="summary">
208 <span class="summary-type">&nbsp;</span>
209 </td><td class="summary">
210 <table width="100%" cellpadding="0" cellspacing="0" border="0">
211 <tr>
212 <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>,
213 <span class="summary-sig-arg">module</span>,
214 <span class="summary-sig-arg">className</span>)</span><br />
215 It removes the ignored methods of each module or class mentioned in
216 ofadriver.cfg.</td>
217 <td align="right" valign="top">
218 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.method_ignoreList">source&nbsp;code</a></span>
219
220 </td>
221 </tr>
222 </table>
223
224 </td>
225 </tr>
226<tr>
227 <td width="15%" align="right" valign="top" class="summary">
228 <span class="summary-type">&nbsp;</span>
229 </td><td class="summary">
230 <table width="100%" cellpadding="0" cellspacing="0" border="0">
231 <tr>
232 <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>,
233 <span class="summary-sig-arg">module</span>,
234 <span class="summary-sig-arg">className</span>)</span><br />
235 This will add the methods(mentioned in ofadriver.cfg file) into
236 method list if it doesnot exists in list.</td>
237 <td align="right" valign="top">
238 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.add_method">source&nbsp;code</a></span>
239
240 </td>
241 </tr>
242 </table>
243
244 </td>
245 </tr>
246<tr>
247 <td width="15%" align="right" valign="top" class="summary">
248 <span class="summary-type">&nbsp;</span>
249 </td><td class="summary">
250 <table width="100%" cellpadding="0" cellspacing="0" border="0">
251 <tr>
252 <td><span class="summary-sig"><a name="getMethodArgsHash"></a><span class="summary-sig-name">getMethodArgsHash</span>(<span class="summary-sig-arg">self</span>,
253 <span class="summary-sig-arg">moduleName</span>,
254 <span class="summary-sig-arg">module</span>,
255 <span class="summary-sig-arg">className</span>)</span><br />
256 This will maintain a Hash of class-&gt;method-&gt;argumentsList</td>
257 <td align="right" valign="top">
258 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getMethodArgsHash">source&nbsp;code</a></span>
259
260 </td>
261 </tr>
262 </table>
263
264 </td>
265 </tr>
266<tr>
267 <td width="15%" align="right" valign="top" class="summary">
268 <span class="summary-type">&nbsp;</span>
269 </td><td class="summary">
270 <table width="100%" cellpadding="0" cellspacing="0" border="0">
271 <tr>
272 <td><span class="summary-sig"><a name="appendDriver"></a><span class="summary-sig-name">appendDriver</span>(<span class="summary-sig-arg">self</span>,
273 <span class="summary-sig-arg">fileName</span>)</span><br />
274 This will append the given driver file with methods along with
275 arguments.</td>
276 <td align="right" valign="top">
277 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.appendDriver">source&nbsp;code</a></span>
278
279 </td>
280 </tr>
281 </table>
282
283 </td>
284 </tr>
285<tr>
286 <td width="15%" align="right" valign="top" class="summary">
287 <span class="summary-type">&nbsp;</span>
288 </td><td class="summary">
289 <table width="100%" cellpadding="0" cellspacing="0" border="0">
290 <tr>
291 <td><span class="summary-sig"><a name="writeDriver"></a><span class="summary-sig-name">writeDriver</span>(<span class="summary-sig-arg">self</span>,
292 <span class="summary-sig-arg">driver</span>)</span><br />
293 This will accept the List of driver name and write those drivers if
294 no driver name is specified then it will write all of the driver
295 specified in the ofadriver.cfg.</td>
296 <td align="right" valign="top">
297 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.writeDriver">source&nbsp;code</a></span>
298
299 </td>
300 </tr>
301 </table>
302
303 </td>
304 </tr>
305<tr>
306 <td width="15%" align="right" valign="top" class="summary">
307 <span class="summary-type">&nbsp;</span>
308 </td><td class="summary">
309 <table width="100%" cellpadding="0" cellspacing="0" border="0">
310 <tr>
311 <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 />
312 It will set the driver path and returns it.If driver path is not
313 specified then it will take default path (/lib/updatedriver/).</td>
314 <td align="right" valign="top">
315 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getDriverPath">source&nbsp;code</a></span>
316
317 </td>
318 </tr>
319 </table>
320
321 </td>
322 </tr>
323<tr>
324 <td width="15%" align="right" valign="top" class="summary">
325 <span class="summary-type">&nbsp;</span>
326 </td><td class="summary">
327 <table width="100%" cellpadding="0" cellspacing="0" border="0">
328 <tr>
329 <td><span class="summary-sig"><a name="printHeader"></a><span class="summary-sig-name">printHeader</span>(<span class="summary-sig-arg">self</span>,
330 <span class="summary-sig-arg">driver</span>)</span></td>
331 <td align="right" valign="top">
332 <span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.printHeader">source&nbsp;code</a></span>
333
334 </td>
335 </tr>
336 </table>
337
338 </td>
339 </tr>
340</table>
341<!-- ==================== METHOD DETAILS ==================== -->
342<a name="section-MethodDetails"></a>
343<table class="details" border="1" cellpadding="3"
344 cellspacing="0" width="100%" bgcolor="white">
345<tr bgcolor="#70b0f0" class="table-header">
346 <td colspan="2" class="table-header">
347 <table border="0" cellpadding="0" cellspacing="0" width="100%">
348 <tr valign="top">
349 <td align="left"><span class="table-header">Method Details</span></td>
350 <td align="right" valign="top"
351 ><span class="options">[<a href="#section-MethodDetails"
352 class="privatelink" onclick="toggle_private();"
353 >hide private</a>]</span></td>
354 </tr>
355 </table>
356 </td>
357</tr>
358</table>
359<a name="getmethods"></a>
360<div>
361<table class="details" border="1" cellpadding="3"
362 cellspacing="0" width="100%" bgcolor="white">
363<tr><td>
364 <table width="100%" cellpadding="0" cellspacing="0" border="0">
365 <tr valign="top"><td>
366 <h3 class="epydoc"><span class="sig"><span class="sig-name">getmethods</span>(<span class="sig-arg">self</span>,
367 <span class="sig-arg">modulePath</span>,
368 <span class="sig-arg">Class</span>)</span>
369 </h3>
370 </td><td align="right" valign="top"
371 ><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getmethods">source&nbsp;code</a></span>&nbsp;
372 </td>
373 </tr></table>
374
375 <p>This will get the list of methods in given module or class. It accepts
376 the module path and class name. If there is no class name then it has be
377 mentioned as None.</p>
378 <dl class="fields">
379 </dl>
380</td></tr></table>
381</div>
382<a name="getargs"></a>
383<div>
384<table class="details" border="1" cellpadding="3"
385 cellspacing="0" width="100%" bgcolor="white">
386<tr><td>
387 <table width="100%" cellpadding="0" cellspacing="0" border="0">
388 <tr valign="top"><td>
389 <h3 class="epydoc"><span class="sig"><span class="sig-name">getargs</span>(<span class="sig-arg">self</span>,
390 <span class="sig-arg">moduleName</span>,
391 <span class="sig-arg">className</span>,
392 <span class="sig-arg">method</span>)</span>
393 </h3>
394 </td><td align="right" valign="top"
395 ><span class="codelink"><a href="TestON.bin.updatedriver-pysrc.html#UpdateDriver.getargs">source&nbsp;code</a></span>&nbsp;
396 </td>
397 </tr></table>
398
399 <p>This will return the list of arguments in a method of python module of
400 class. It accepts method list as an argument.</p>
401 <dl class="fields">
402 </dl>
403</td></tr></table>
404</div>
405<br />
406<!-- ==================== NAVIGATION BAR ==================== -->
407<table class="navbar" border="0" width="100%" cellpadding="0"
408 bgcolor="#a0c0ff" cellspacing="0">
409 <tr valign="middle">
410 <!-- Home link -->
411 <th>&nbsp;&nbsp;&nbsp;<a
412 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
413
414 <!-- Tree link -->
415 <th>&nbsp;&nbsp;&nbsp;<a
416 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
417
418 <!-- Index link -->
419 <th>&nbsp;&nbsp;&nbsp;<a
420 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
421
422 <!-- Help link -->
423 <th>&nbsp;&nbsp;&nbsp;<a
424 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
425
426 <th class="navbar" width="100%"></th>
427 </tr>
428</table>
429<table border="0" cellpadding="0" cellspacing="0" width="100%%">
430 <tr>
431 <td align="left" class="footer">
432 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
433 </td>
434 <td align="right" class="footer">
435 <a target="mainFrame" href="http://epydoc.sourceforge.net"
436 >http://epydoc.sourceforge.net</a>
437 </td>
438 </tr>
439</table>
440
441<script type="text/javascript">
442 <!--
443 // Private objects are initially displayed (because if
444 // javascript is turned off then we want them to be
445 // visible); but by default, we want to hide them. So hide
446 // them unless we have a cookie that says to show them.
447 checkCookie();
448 // -->
449</script>
450</body>
451</html>