Mercurial > repos > yufei-luo > s_mart
view commons/pyRepetUnit/doc/commons.IComponentWrapper-pysrc.html @ 31:0ab839023fe4
Uploaded
| author | m-zytnicki |
|---|---|
| date | Tue, 30 Apr 2013 14:33:21 -0400 |
| parents | 94ab73e8a190 |
| children |
line wrap: on
line source
<?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>commons.IComponentWrapper</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"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></th> </tr> </table> <table width="100%" cellpadding="0" cellspacing="0"> <tr valign="top"> <td width="100%"> <span class="breadcrumbs"> Package commons :: Module IComponentWrapper </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 private</a>]</span></td></tr> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="commons.IComponentWrapper-pysrc.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <h1 class="epydoc">Source Code for <a href="commons.IComponentWrapper-module.html">Module commons.IComponentWrapper</a></h1> <pre class="py-src"> <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"> </tt> <a name="IComponentWrapper"></a><div id="IComponentWrapper-def"><a name="L2"></a><tt class="py-lineno"> 2</tt> <a class="py-toggle" href="#" id="IComponentWrapper-toggle" onclick="return toggle('IComponentWrapper');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html">IComponentWrapper</a><tt class="py-op">:</tt> </tt> </div><div id="IComponentWrapper-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="IComponentWrapper-expanded"><a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"><tt class="py-docstring"> A interface wrapper for all pipelines component</tt> </tt> <a name="L5"></a><tt class="py-lineno"> 5</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"> </tt> <a name="IComponentWrapper.run"></a><div id="IComponentWrapper.run-def"><a name="L7"></a><tt class="py-lineno"> 7</tt> <a class="py-toggle" href="#" id="IComponentWrapper.run-toggle" onclick="return toggle('IComponentWrapper.run');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#run">run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> </div><div id="IComponentWrapper.run-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.run-expanded"><a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> run the component</tt> </tt> <a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> </div><a name="L12"></a><tt class="py-lineno">12</tt> <tt class="py-line"> </tt> <a name="IComponentWrapper.loadConfig"></a><div id="IComponentWrapper.loadConfig-def"><a name="L13"></a><tt class="py-lineno">13</tt> <a class="py-toggle" href="#" id="IComponentWrapper.loadConfig-toggle" onclick="return toggle('IComponentWrapper.loadConfig');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#loadConfig">loadConfig</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">configParserInstance</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> </div><div id="IComponentWrapper.loadConfig-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.loadConfig-expanded"><a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> <a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring"> load component config</tt> </tt> <a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt> <a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-docstring"> @param configParserInstance: config parser where config file is loaded</tt> </tt> <a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-docstring"> @type configParserInstance: class ConfigParser</tt> </tt> <a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> </div><a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"> </tt> <a name="IComponentWrapper.clean"></a><div id="IComponentWrapper.clean-def"><a name="L22"></a><tt class="py-lineno">22</tt> <a class="py-toggle" href="#" id="IComponentWrapper.clean-toggle" onclick="return toggle('IComponentWrapper.clean');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#clean">clean</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> </div><div id="IComponentWrapper.clean-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.clean-expanded"><a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> <a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"><tt class="py-docstring"> clean files generated by run method</tt> </tt> <a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> <a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"> <tt class="py-keyword">pass</tt> </tt> </div><a name="L27"></a><tt class="py-lineno">27</tt> <tt class="py-line"> </tt> <a name="IComponentWrapper.getComponent"></a><div id="IComponentWrapper.getComponent-def"><a name="L28"></a><tt class="py-lineno">28</tt> <a class="py-toggle" href="#" id="IComponentWrapper.getComponent-toggle" onclick="return toggle('IComponentWrapper.getComponent');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="commons.IComponentWrapper.IComponentWrapper-class.html#getComponent">getComponent</a> <tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt> </div><div id="IComponentWrapper.getComponent-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="IComponentWrapper.getComponent-expanded"><a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"> <tt class="py-docstring">"""</tt> </tt> <a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring"> return component wrapped</tt> </tt> <a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt> </div></div><a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"> </tt><script type="text/javascript"> <!-- expandto(location.href); // --> </script> </pre> <br /> <!-- ==================== NAVIGATION BAR ==================== --> <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> <tr valign="middle"> <!-- Tree link --> <th> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </th> <th class="navbar" width="100%"></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 Fri Apr 10 16:39:01 2009 </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>