Gitiles
Code Review Sign In
gerrit.onosproject.org / OnosSystemTest / 689d8e47d7b4cbb05d0b4d9ddd572c5c6c49a5c6 / . / TestON / Documentation / TestON_Document / TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html
blob: 7452bebd1509d2d8a5f1a2af4ad084fdfca23d88 [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.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver</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.drivers-module.html">Package&nbsp;drivers</a> ::
42 <a href="TestON.drivers.common-module.html">Package&nbsp;common</a> ::
43 <a href="TestON.drivers.common.cli-module.html">Package&nbsp;cli</a> ::
44 <a href="TestON.drivers.common.cli.tool-module.html">Package&nbsp;tool</a> ::
45 <a href="TestON.drivers.common.cli.tool.dpctlclidriver-module.html">Module&nbsp;dpctlclidriver</a> ::
46 Class&nbsp;DpctlCliDriver
47 </span>
48 </td>
49 <td>
50 <table cellpadding="0" cellspacing="0">
51 <!-- hide/show private -->
52 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
53 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
54 <tr><td align="right"><span class="options"
55 >[<a href="frames.html" target="_top">frames</a
56 >]&nbsp;|&nbsp;<a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html"
57 target="_top">no&nbsp;frames</a>]</span></td></tr>
58 </table>
59 </td>
60 </tr>
61</table>
62<!-- ==================== CLASS DESCRIPTION ==================== -->
63<h1 class="epydoc">Class DpctlCliDriver</h1><p class="nomargin-top"><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver">source&nbsp;code</a></span></p>
64<pre class="base-tree">
65 object --+
66 |
67<a href="TestON.drivers.component.Component-class.html">component.Component</a> --+
68 |
69 <a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a> --+
70 |
71 <a href="TestON.drivers.common.cli.toolsdriver.Tools-class.html">toolsdriver.Tools</a> --+
72 |
73 <strong class="uidshort">DpctlCliDriver</strong>
74</pre>
75
76<hr />
77<p>DpctlCliDriver driver class provides the basic functions of DPCTL
78 controller</p>
79
80<!-- ==================== INSTANCE METHODS ==================== -->
81<a name="section-InstanceMethods"></a>
82<table class="summary" border="1" cellpadding="3"
83 cellspacing="0" width="100%" bgcolor="white">
84<tr bgcolor="#70b0f0" class="table-header">
85 <td colspan="2" class="table-header">
86 <table border="0" cellpadding="0" cellspacing="0" width="100%">
87 <tr valign="top">
88 <td align="left"><span class="table-header">Instance Methods</span></td>
89 <td align="right" valign="top"
90 ><span class="options">[<a href="#section-InstanceMethods"
91 class="privatelink" onclick="toggle_private();"
92 >hide private</a>]</span></td>
93 </tr>
94 </table>
95 </td>
96</tr>
97<tr>
98 <td width="15%" align="right" valign="top" class="summary">
99 <span class="summary-type">&nbsp;</span>
100 </td><td class="summary">
101 <table width="100%" cellpadding="0" cellspacing="0" border="0">
102 <tr>
103 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
104 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
105 <td align="right" valign="top">
106 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.__init__">source&nbsp;code</a></span>
107
108 </td>
109 </tr>
110 </table>
111
112 </td>
113 </tr>
114<tr>
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type">&nbsp;</span>
117 </td><td class="summary">
118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <tr>
120 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#connect" class="summary-sig-name">connect</a>(<span class="summary-sig-arg">self</span>,
121 <span class="summary-sig-arg">**connectargs</span>)</span><br />
122 Connection will establish to the remote host using ssh.</td>
123 <td align="right" valign="top">
124 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.connect">source&nbsp;code</a></span>
125
126 </td>
127 </tr>
128 </table>
129
130 </td>
131 </tr>
132<tr>
133 <td width="15%" align="right" valign="top" class="summary">
134 <span class="summary-type">&nbsp;</span>
135 </td><td class="summary">
136 <table width="100%" cellpadding="0" cellspacing="0" border="0">
137 <tr>
138 <td><span class="summary-sig"><a name="addFlow"></a><span class="summary-sig-name">addFlow</span>(<span class="summary-sig-arg">self</span>,
139 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
140 addFlow create a new flow entry into flow table using
141 &quot;dpctl&quot;</td>
142 <td align="right" valign="top">
143 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.addFlow">source&nbsp;code</a></span>
144
145 </td>
146 </tr>
147 </table>
148
149 </td>
150 </tr>
151<tr>
152 <td width="15%" align="right" valign="top" class="summary">
153 <span class="summary-type">&nbsp;</span>
154 </td><td class="summary">
155 <table width="100%" cellpadding="0" cellspacing="0" border="0">
156 <tr>
157 <td><span class="summary-sig"><a name="showFlow"></a><span class="summary-sig-name">showFlow</span>(<span class="summary-sig-arg">self</span>,
158 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
159 showFlow dumps the flow entries of flow table using &quot;dpctl&quot;</td>
160 <td align="right" valign="top">
161 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showFlow">source&nbsp;code</a></span>
162
163 </td>
164 </tr>
165 </table>
166
167 </td>
168 </tr>
169<tr>
170 <td width="15%" align="right" valign="top" class="summary">
171 <span class="summary-type">&nbsp;</span>
172 </td><td class="summary">
173 <table width="100%" cellpadding="0" cellspacing="0" border="0">
174 <tr>
175 <td><span class="summary-sig"><a name="dumpFlow"></a><span class="summary-sig-name">dumpFlow</span>(<span class="summary-sig-arg">self</span>,
176 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
177 dumpFlow gives installed flow information</td>
178 <td align="right" valign="top">
179 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpFlow">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="dumpTables"></a><span class="summary-sig-name">dumpTables</span>(<span class="summary-sig-arg">self</span>,
194 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
195 dumpTables gives statistics for each of the flow tables used by
196 datapath switch.</td>
197 <td align="right" valign="top">
198 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpTables">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="dumpPorts"></a><span class="summary-sig-name">dumpPorts</span>(<span class="summary-sig-arg">self</span>,
213 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
214 dumpPorts gives ports information</td>
215 <td align="right" valign="top">
216 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpPorts">source&nbsp;code</a></span>
217
218 </td>
219 </tr>
220 </table>
221
222 </td>
223 </tr>
224<tr>
225 <td width="15%" align="right" valign="top" class="summary">
226 <span class="summary-type">&nbsp;</span>
227 </td><td class="summary">
228 <table width="100%" cellpadding="0" cellspacing="0" border="0">
229 <tr>
230 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#dumpAggregate" class="summary-sig-name">dumpAggregate</a>(<span class="summary-sig-arg">self</span>,
231 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
232 dumpAggregate gives installed flow information.ggregate statistics
233 for flows in datapath WITCH's tables that match flows.</td>
234 <td align="right" valign="top">
235 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpAggregate">source&nbsp;code</a></span>
236
237 </td>
238 </tr>
239 </table>
240
241 </td>
242 </tr>
243<tr>
244 <td width="15%" align="right" valign="top" class="summary">
245 <span class="summary-type">&nbsp;</span>
246 </td><td class="summary">
247 <table width="100%" cellpadding="0" cellspacing="0" border="0">
248 <tr>
249 <td><span class="summary-sig"><a name="delFlow"></a><span class="summary-sig-name">delFlow</span>(<span class="summary-sig-arg">self</span>,
250 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
251 delFlow Deletes entries from the datapath switch's tables that match
252 flow</td>
253 <td align="right" valign="top">
254 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.delFlow">source&nbsp;code</a></span>
255
256 </td>
257 </tr>
258 </table>
259
260 </td>
261 </tr>
262<tr>
263 <td width="15%" align="right" valign="top" class="summary">
264 <span class="summary-type">&nbsp;</span>
265 </td><td class="summary">
266 <table width="100%" cellpadding="0" cellspacing="0" border="0">
267 <tr>
268 <td><span class="summary-sig"><a name="show"></a><span class="summary-sig-name">show</span>(<span class="summary-sig-arg">self</span>,
269 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
270 show gives information on datapath switch including information on
271 its flow tables and ports.</td>
272 <td align="right" valign="top">
273 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.show">source&nbsp;code</a></span>
274
275 </td>
276 </tr>
277 </table>
278
279 </td>
280 </tr>
281<tr>
282 <td width="15%" align="right" valign="top" class="summary">
283 <span class="summary-type">&nbsp;</span>
284 </td><td class="summary">
285 <table width="100%" cellpadding="0" cellspacing="0" border="0">
286 <tr>
287 <td><span class="summary-sig"><a href="TestON.drivers.common.cli.tool.dpctlclidriver.DpctlCliDriver-class.html#showStatus" class="summary-sig-name">showStatus</a>(<span class="summary-sig-arg">self</span>,
288 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
289 showStatus gives a series of key-value pairs that report the status
290 of switch.</td>
291 <td align="right" valign="top">
292 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showStatus">source&nbsp;code</a></span>
293
294 </td>
295 </tr>
296 </table>
297
298 </td>
299 </tr>
300<tr>
301 <td width="15%" align="right" valign="top" class="summary">
302 <span class="summary-type">&nbsp;</span>
303 </td><td class="summary">
304 <table width="100%" cellpadding="0" cellspacing="0" border="0">
305 <tr>
306 <td><span class="summary-sig"><a name="desc_set"></a><span class="summary-sig-name">desc_set</span>(<span class="summary-sig-arg">self</span>,
307 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
308 desc_set Sets the switch description (as returned in ofp_desc_stats)
309 to string (max length is DESC_STR_LEN)</td>
310 <td align="right" valign="top">
311 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.desc_set">source&nbsp;code</a></span>
312
313 </td>
314 </tr>
315 </table>
316
317 </td>
318 </tr>
319<tr>
320 <td width="15%" align="right" valign="top" class="summary">
321 <span class="summary-type">&nbsp;</span>
322 </td><td class="summary">
323 <table width="100%" cellpadding="0" cellspacing="0" border="0">
324 <tr>
325 <td><span class="summary-sig"><a name="dumpDesc"></a><span class="summary-sig-name">dumpDesc</span>(<span class="summary-sig-arg">self</span>,
326 <span class="summary-sig-arg">**flowParameters</span>)</span><br />
327 dumpDesc Sets the switch description (as returned in ofp_desc_stats)
328 to string (max length is DESC_STR_LEN)</td>
329 <td align="right" valign="top">
330 <span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpDesc">source&nbsp;code</a></span>
331
332 </td>
333 </tr>
334 </table>
335
336 </td>
337 </tr>
338 <tr>
339 <td colspan="2" class="summary">
340 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.common.clidriver.CLI-class.html">clidriver.CLI</a></code></b>:
341 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#disconnect">disconnect</a></code>,
342 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#execute">execute</a></code>,
343 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#onfail">onfail</a></code>,
344 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#runAsSudoUser">runAsSudoUser</a></code>,
345 <code><a href="TestON.drivers.common.clidriver.CLI-class.html#secureCopy">secureCopy</a></code>
346 </p>
347 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="TestON.drivers.component.Component-class.html">component.Component</a></code></b>:
348 <code><a href="TestON.drivers.component.Component-class.html#__getattr__">__getattr__</a></code>,
349 <code><a href="TestON.drivers.component.Component-class.html#cleanup">cleanup</a></code>,
350 <code><a href="TestON.drivers.component.Component-class.html#close_log_handles">close_log_handles</a></code>,
351 <code><a href="TestON.drivers.component.Component-class.html#config">config</a></code>,
352 <code><a href="TestON.drivers.component.Component-class.html#experimentRun">experimentRun</a></code>,
353 <code><a href="TestON.drivers.component.Component-class.html#get_version">get_version</a></code>,
354 <code><a href="TestON.drivers.component.Component-class.html#log">log</a></code>
355 </p>
356 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
357 <code>__delattr__</code>,
358 <code>__format__</code>,
359 <code>__getattribute__</code>,
360 <code>__hash__</code>,
361 <code>__new__</code>,
362 <code>__reduce__</code>,
363 <code>__reduce_ex__</code>,
364 <code>__repr__</code>,
365 <code>__setattr__</code>,
366 <code>__sizeof__</code>,
367 <code>__str__</code>,
368 <code>__subclasshook__</code>
369 </p>
370 </td>
371 </tr>
372</table>
373<!-- ==================== PROPERTIES ==================== -->
374<a name="section-Properties"></a>
375<table class="summary" border="1" cellpadding="3"
376 cellspacing="0" width="100%" bgcolor="white">
377<tr bgcolor="#70b0f0" class="table-header">
378 <td colspan="2" class="table-header">
379 <table border="0" cellpadding="0" cellspacing="0" width="100%">
380 <tr valign="top">
381 <td align="left"><span class="table-header">Properties</span></td>
382 <td align="right" valign="top"
383 ><span class="options">[<a href="#section-Properties"
384 class="privatelink" onclick="toggle_private();"
385 >hide private</a>]</span></td>
386 </tr>
387 </table>
388 </td>
389</tr>
390 <tr>
391 <td colspan="2" class="summary">
392 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
393 <code>__class__</code>
394 </p>
395 </td>
396 </tr>
397</table>
398<!-- ==================== METHOD DETAILS ==================== -->
399<a name="section-MethodDetails"></a>
400<table class="details" border="1" cellpadding="3"
401 cellspacing="0" width="100%" bgcolor="white">
402<tr bgcolor="#70b0f0" class="table-header">
403 <td colspan="2" class="table-header">
404 <table border="0" cellpadding="0" cellspacing="0" width="100%">
405 <tr valign="top">
406 <td align="left"><span class="table-header">Method Details</span></td>
407 <td align="right" valign="top"
408 ><span class="options">[<a href="#section-MethodDetails"
409 class="privatelink" onclick="toggle_private();"
410 >hide private</a>]</span></td>
411 </tr>
412 </table>
413 </td>
414</tr>
415</table>
416<a name="__init__"></a>
417<div>
418<table class="details" border="1" cellpadding="3"
419 cellspacing="0" width="100%" bgcolor="white">
420<tr><td>
421 <table width="100%" cellpadding="0" cellspacing="0" border="0">
422 <tr valign="top"><td>
423 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
424 <br /><em class="fname">(Constructor)</em>
425 </h3>
426 </td><td align="right" valign="top"
427 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.__init__">source&nbsp;code</a></span>&nbsp;
428 </td>
429 </tr></table>
430
431 <p>x.__init__(...) initializes x; see x.__class__.__doc__ for
432 signature</p>
433 <dl class="fields">
434 <dt>Overrides:
435 object.__init__
436 <dd><em class="note">(inherited documentation)</em></dd>
437 </dt>
438 </dl>
439</td></tr></table>
440</div>
441<a name="connect"></a>
442<div>
443<table class="details" border="1" cellpadding="3"
444 cellspacing="0" width="100%" bgcolor="white">
445<tr><td>
446 <table width="100%" cellpadding="0" cellspacing="0" border="0">
447 <tr valign="top"><td>
448 <h3 class="epydoc"><span class="sig"><span class="sig-name">connect</span>(<span class="sig-arg">self</span>,
449 <span class="sig-arg">**connectargs</span>)</span>
450 </h3>
451 </td><td align="right" valign="top"
452 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.connect">source&nbsp;code</a></span>&nbsp;
453 </td>
454 </tr></table>
455
456 <p>Connection will establish to the remote host using ssh. It will take
457 user_name ,ip_address and password as arguments&lt;br&gt; and will return
458 the handle.</p>
459 <dl class="fields">
460 <dt>Overrides:
461 <a href="TestON.drivers.component.Component-class.html#connect">component.Component.connect</a>
462 </dt>
463 </dl>
464</td></tr></table>
465</div>
466<a name="dumpAggregate"></a>
467<div>
468<table class="details" border="1" cellpadding="3"
469 cellspacing="0" width="100%" bgcolor="white">
470<tr><td>
471 <table width="100%" cellpadding="0" cellspacing="0" border="0">
472 <tr valign="top"><td>
473 <h3 class="epydoc"><span class="sig"><span class="sig-name">dumpAggregate</span>(<span class="sig-arg">self</span>,
474 <span class="sig-arg">**flowParameters</span>)</span>
475 </h3>
476 </td><td align="right" valign="top"
477 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.dumpAggregate">source&nbsp;code</a></span>&nbsp;
478 </td>
479 </tr></table>
480
481 <p>dumpAggregate gives installed flow information.ggregate statistics
482 for flows in datapath WITCH's tables that match flows. If flows is
483 omitted, the statistics are aggregated across all flows in the datapath's
484 flow tables</p>
485 <dl class="fields">
486 </dl>
487</td></tr></table>
488</div>
489<a name="showStatus"></a>
490<div>
491<table class="details" border="1" cellpadding="3"
492 cellspacing="0" width="100%" bgcolor="white">
493<tr><td>
494 <table width="100%" cellpadding="0" cellspacing="0" border="0">
495 <tr valign="top"><td>
496 <h3 class="epydoc"><span class="sig"><span class="sig-name">showStatus</span>(<span class="sig-arg">self</span>,
497 <span class="sig-arg">**flowParameters</span>)</span>
498 </h3>
499 </td><td align="right" valign="top"
500 ><span class="codelink"><a href="TestON.drivers.common.cli.tool.dpctlclidriver-pysrc.html#DpctlCliDriver.showStatus">source&nbsp;code</a></span>&nbsp;
501 </td>
502 </tr></table>
503
504 <p>showStatus gives a series of key-value pairs that report the status of
505 switch. If key is specified, only the key-value pairs whose key names
506 begin with key are printed.</p>
507 <dl class="fields">
508 </dl>
509</td></tr></table>
510</div>
511<br />
512<!-- ==================== NAVIGATION BAR ==================== -->
513<table class="navbar" border="0" width="100%" cellpadding="0"
514 bgcolor="#a0c0ff" cellspacing="0">
515 <tr valign="middle">
516 <!-- Home link -->
517 <th>&nbsp;&nbsp;&nbsp;<a
518 href="TestON-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
519
520 <!-- Tree link -->
521 <th>&nbsp;&nbsp;&nbsp;<a
522 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
523
524 <!-- Index link -->
525 <th>&nbsp;&nbsp;&nbsp;<a
526 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
527
528 <!-- Help link -->
529 <th>&nbsp;&nbsp;&nbsp;<a
530 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
531
532 <th class="navbar" width="100%"></th>
533 </tr>
534</table>
535<table border="0" cellpadding="0" cellspacing="0" width="100%%">
536 <tr>
537 <td align="left" class="footer">
538 Generated by Epydoc 3.0.1 on Mon Mar 11 12:56:26 2013
539 </td>
540 <td align="right" class="footer">
541 <a target="mainFrame" href="http://epydoc.sourceforge.net"
542 >http://epydoc.sourceforge.net</a>
543 </td>
544 </tr>
545</table>
546
547<script type="text/javascript">
548 <!--
549 // Private objects are initially displayed (because if
550 // javascript is turned off then we want them to be
551 // visible); but by default, we want to hide them. So hide
552 // them unless we have a cookie that says to show them.
553 checkCookie();
554 // -->
555</script>
556</body>
557</html>