|
18
|
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>commons.IComponentWrapper.IComponentWrapper</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
|
|
|
18 <!-- Tree link -->
|
|
|
19 <th> <a
|
|
|
20 href="module-tree.html">Trees</a> </th>
|
|
|
21
|
|
|
22 <!-- Index link -->
|
|
|
23 <th> <a
|
|
|
24 href="identifier-index.html">Indices</a> </th>
|
|
|
25
|
|
|
26 <!-- Help link -->
|
|
|
27 <th> <a
|
|
|
28 href="help.html">Help</a> </th>
|
|
|
29
|
|
|
30 <th class="navbar" width="100%"></th>
|
|
|
31 </tr>
|
|
|
32 </table>
|
|
|
33 <table width="100%" cellpadding="0" cellspacing="0">
|
|
|
34 <tr valign="top">
|
|
|
35 <td width="100%">
|
|
|
36 <span class="breadcrumbs">
|
|
|
37 Package commons ::
|
|
|
38 <a href="commons.IComponentWrapper-module.html">Module IComponentWrapper</a> ::
|
|
|
39 Class IComponentWrapper
|
|
|
40 </span>
|
|
|
41 </td>
|
|
|
42 <td>
|
|
|
43 <table cellpadding="0" cellspacing="0">
|
|
|
44 <!-- hide/show private -->
|
|
|
45 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
|
|
|
46 onclick="toggle_private();">hide private</a>]</span></td></tr>
|
|
|
47 <tr><td align="right"><span class="options"
|
|
|
48 >[<a href="frames.html" target="_top">frames</a
|
|
|
49 >] | <a href="commons.IComponentWrapper.IComponentWrapper-class.html"
|
|
|
50 target="_top">no frames</a>]</span></td></tr>
|
|
|
51 </table>
|
|
|
52 </td>
|
|
|
53 </tr>
|
|
|
54 </table>
|
|
|
55 <!-- ==================== CLASS DESCRIPTION ==================== -->
|
|
|
56 <h1 class="epydoc">Class IComponentWrapper</h1><p class="nomargin-top"><span class="codelink"><a href="commons.IComponentWrapper-pysrc.html#IComponentWrapper">source code</a></span></p>
|
|
|
57 <p>A interface wrapper for all pipelines component</p>
|
|
|
58
|
|
|
59 <!-- ==================== INSTANCE METHODS ==================== -->
|
|
|
60 <a name="section-InstanceMethods"></a>
|
|
|
61 <table class="summary" border="1" cellpadding="3"
|
|
|
62 cellspacing="0" width="100%" bgcolor="white">
|
|
|
63 <tr bgcolor="#70b0f0" class="table-header">
|
|
|
64 <td colspan="2" class="table-header">
|
|
|
65 <table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
|
66 <tr valign="top">
|
|
|
67 <td align="left"><span class="table-header">Instance Methods</span></td>
|
|
|
68 <td align="right" valign="top"
|
|
|
69 ><span class="options">[<a href="#section-InstanceMethods"
|
|
|
70 class="privatelink" onclick="toggle_private();"
|
|
|
71 >hide private</a>]</span></td>
|
|
|
72 </tr>
|
|
|
73 </table>
|
|
|
74 </td>
|
|
|
75 </tr>
|
|
|
76 <tr>
|
|
|
77 <td width="15%" align="right" valign="top" class="summary">
|
|
|
78 <span class="summary-type"> </span>
|
|
|
79 </td><td class="summary">
|
|
|
80 <table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
|
81 <tr>
|
|
|
82 <td><span class="summary-sig"><a name="clean"></a><span class="summary-sig-name">clean</span>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
|
83 clean files generated by run method</td>
|
|
|
84 <td align="right" valign="top">
|
|
|
85 <span class="codelink"><a href="commons.IComponentWrapper-pysrc.html#IComponentWrapper.clean">source code</a></span>
|
|
|
86
|
|
|
87 </td>
|
|
|
88 </tr>
|
|
|
89 </table>
|
|
|
90
|
|
|
91 </td>
|
|
|
92 </tr>
|
|
|
93 <tr>
|
|
|
94 <td width="15%" align="right" valign="top" class="summary">
|
|
|
95 <span class="summary-type"> </span>
|
|
|
96 </td><td class="summary">
|
|
|
97 <table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
|
98 <tr>
|
|
|
99 <td><span class="summary-sig"><a name="getComponent"></a><span class="summary-sig-name">getComponent</span>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
|
100 return component wrapped</td>
|
|
|
101 <td align="right" valign="top">
|
|
|
102 <span class="codelink"><a href="commons.IComponentWrapper-pysrc.html#IComponentWrapper.getComponent">source code</a></span>
|
|
|
103
|
|
|
104 </td>
|
|
|
105 </tr>
|
|
|
106 </table>
|
|
|
107
|
|
|
108 </td>
|
|
|
109 </tr>
|
|
|
110 <tr>
|
|
|
111 <td width="15%" align="right" valign="top" class="summary">
|
|
|
112 <span class="summary-type"> </span>
|
|
|
113 </td><td class="summary">
|
|
|
114 <table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
|
115 <tr>
|
|
|
116 <td><span class="summary-sig"><a href="commons.IComponentWrapper.IComponentWrapper-class.html#loadConfig" class="summary-sig-name">loadConfig</a>(<span class="summary-sig-arg">self</span>,
|
|
|
117 <span class="summary-sig-arg">configParserInstance</span>)</span><br />
|
|
|
118 load component config</td>
|
|
|
119 <td align="right" valign="top">
|
|
|
120 <span class="codelink"><a href="commons.IComponentWrapper-pysrc.html#IComponentWrapper.loadConfig">source code</a></span>
|
|
|
121
|
|
|
122 </td>
|
|
|
123 </tr>
|
|
|
124 </table>
|
|
|
125
|
|
|
126 </td>
|
|
|
127 </tr>
|
|
|
128 <tr>
|
|
|
129 <td width="15%" align="right" valign="top" class="summary">
|
|
|
130 <span class="summary-type"> </span>
|
|
|
131 </td><td class="summary">
|
|
|
132 <table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
|
133 <tr>
|
|
|
134 <td><span class="summary-sig"><a name="run"></a><span class="summary-sig-name">run</span>(<span class="summary-sig-arg">self</span>)</span><br />
|
|
|
135 run the component</td>
|
|
|
136 <td align="right" valign="top">
|
|
|
137 <span class="codelink"><a href="commons.IComponentWrapper-pysrc.html#IComponentWrapper.run">source code</a></span>
|
|
|
138
|
|
|
139 </td>
|
|
|
140 </tr>
|
|
|
141 </table>
|
|
|
142
|
|
|
143 </td>
|
|
|
144 </tr>
|
|
|
145 </table>
|
|
|
146 <!-- ==================== METHOD DETAILS ==================== -->
|
|
|
147 <a name="section-MethodDetails"></a>
|
|
|
148 <table class="details" border="1" cellpadding="3"
|
|
|
149 cellspacing="0" width="100%" bgcolor="white">
|
|
|
150 <tr bgcolor="#70b0f0" class="table-header">
|
|
|
151 <td colspan="2" class="table-header">
|
|
|
152 <table border="0" cellpadding="0" cellspacing="0" width="100%">
|
|
|
153 <tr valign="top">
|
|
|
154 <td align="left"><span class="table-header">Method Details</span></td>
|
|
|
155 <td align="right" valign="top"
|
|
|
156 ><span class="options">[<a href="#section-MethodDetails"
|
|
|
157 class="privatelink" onclick="toggle_private();"
|
|
|
158 >hide private</a>]</span></td>
|
|
|
159 </tr>
|
|
|
160 </table>
|
|
|
161 </td>
|
|
|
162 </tr>
|
|
|
163 </table>
|
|
|
164 <a name="loadConfig"></a>
|
|
|
165 <div>
|
|
|
166 <table class="details" border="1" cellpadding="3"
|
|
|
167 cellspacing="0" width="100%" bgcolor="white">
|
|
|
168 <tr><td>
|
|
|
169 <table width="100%" cellpadding="0" cellspacing="0" border="0">
|
|
|
170 <tr valign="top"><td>
|
|
|
171 <h3 class="epydoc"><span class="sig"><span class="sig-name">loadConfig</span>(<span class="sig-arg">self</span>,
|
|
|
172 <span class="sig-arg">configParserInstance</span>)</span>
|
|
|
173 </h3>
|
|
|
174 </td><td align="right" valign="top"
|
|
|
175 ><span class="codelink"><a href="commons.IComponentWrapper-pysrc.html#IComponentWrapper.loadConfig">source code</a></span>
|
|
|
176 </td>
|
|
|
177 </tr></table>
|
|
|
178
|
|
|
179 <p>load component config</p>
|
|
|
180 <dl class="fields">
|
|
|
181 <dt>Parameters:</dt>
|
|
|
182 <dd><ul class="nomargin-top">
|
|
|
183 <li><strong class="pname"><code>configParserInstance</code></strong> (class ConfigParser) - config parser where config file is loaded</li>
|
|
|
184 </ul></dd>
|
|
|
185 </dl>
|
|
|
186 </td></tr></table>
|
|
|
187 </div>
|
|
|
188 <br />
|
|
|
189 <!-- ==================== NAVIGATION BAR ==================== -->
|
|
|
190 <table class="navbar" border="0" width="100%" cellpadding="0"
|
|
|
191 bgcolor="#a0c0ff" cellspacing="0">
|
|
|
192 <tr valign="middle">
|
|
|
193
|
|
|
194 <!-- Tree link -->
|
|
|
195 <th> <a
|
|
|
196 href="module-tree.html">Trees</a> </th>
|
|
|
197
|
|
|
198 <!-- Index link -->
|
|
|
199 <th> <a
|
|
|
200 href="identifier-index.html">Indices</a> </th>
|
|
|
201
|
|
|
202 <!-- Help link -->
|
|
|
203 <th> <a
|
|
|
204 href="help.html">Help</a> </th>
|
|
|
205
|
|
|
206 <th class="navbar" width="100%"></th>
|
|
|
207 </tr>
|
|
|
208 </table>
|
|
|
209 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
|
|
|
210 <tr>
|
|
|
211 <td align="left" class="footer">
|
|
|
212 Generated by Epydoc 3.0.1 on Fri Apr 10 16:39:01 2009
|
|
|
213 </td>
|
|
|
214 <td align="right" class="footer">
|
|
|
215 <a target="mainFrame" href="http://epydoc.sourceforge.net"
|
|
|
216 >http://epydoc.sourceforge.net</a>
|
|
|
217 </td>
|
|
|
218 </tr>
|
|
|
219 </table>
|
|
|
220
|
|
|
221 <script type="text/javascript">
|
|
|
222 <!--
|
|
|
223 // Private objects are initially displayed (because if
|
|
|
224 // javascript is turned off then we want them to be
|
|
|
225 // visible); but by default, we want to hide them. So hide
|
|
|
226 // them unless we have a cookie that says to show them.
|
|
|
227 checkCookie();
|
|
|
228 // -->
|
|
|
229 </script>
|
|
|
230 </body>
|
|
|
231 </html>
|
