doc/api/python/buildtools.EBSWriter-class.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     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>buildtools.EBSWriter</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>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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         <a href="buildtools-module.html">Module&nbsp;buildtools</a> ::
       
    38         Class&nbsp;EBSWriter
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="buildtools.EBSWriter-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class EBSWriter</h1><span class="codelink"><a href="buildtools-pysrc.html#EBSWriter">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 <a href="buildtools.AbstractOutputWriter-class.html">AbstractOutputWriter</a> --+
       
    58                        |
       
    59                       <strong class="uidshort">EBSWriter</strong>
       
    60 </pre>
       
    61 
       
    62 <hr />
       
    63 Implements EBS XML output format.<br /><br />
       
    64 
       
    65 <!-- ==================== INSTANCE METHODS ==================== -->
       
    66 <a name="section-InstanceMethods"></a>
       
    67 <table class="summary" border="1" cellpadding="3"
       
    68        cellspacing="0" width="100%" bgcolor="white">
       
    69 <tr bgcolor="#70b0f0" class="table-header">
       
    70   <td colspan="2" class="table-header">
       
    71     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    72       <tr valign="top">
       
    73         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    74         <td align="right" valign="top"
       
    75          ><span class="options">[<a href="#section-InstanceMethods"
       
    76          class="privatelink" onclick="toggle_private();"
       
    77          >hide private</a>]</span></td>
       
    78       </tr>
       
    79     </table>
       
    80   </td>
       
    81 </tr>
       
    82 <tr>
       
    83     <td width="15%" align="right" valign="top" class="summary">
       
    84       <span class="summary-type">&nbsp;</span>
       
    85     </td><td class="summary">
       
    86       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    87         <tr>
       
    88           <td><span class="summary-sig"><a href="buildtools.EBSWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    89         <span class="summary-sig-arg">fileOut</span>)</span></td>
       
    90           <td align="right" valign="top">
       
    91             <span class="codelink"><a href="buildtools-pysrc.html#EBSWriter.__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="buildtools.EBSWriter-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
       
   106         <span class="summary-sig-arg">cmdList</span>)</span><br />
       
   107       Write the command list to EBS format.</td>
       
   108           <td align="right" valign="top">
       
   109             <span class="codelink"><a href="buildtools-pysrc.html#EBSWriter.write">source&nbsp;code</a></span>
       
   110             
       
   111           </td>
       
   112         </tr>
       
   113       </table>
       
   114       
       
   115     </td>
       
   116   </tr>
       
   117   <tr>
       
   118     <td colspan="2" class="summary">
       
   119     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="buildtools.AbstractOutputWriter-class.html">AbstractOutputWriter</a></code></b>:
       
   120       <code><a href="buildtools.AbstractOutputWriter-class.html#__call__">__call__</a></code>,
       
   121       <code><a href="buildtools.AbstractOutputWriter-class.html#close">close</a></code>,
       
   122       <code><a href="buildtools.AbstractOutputWriter-class.html#writeTopLevel">writeTopLevel</a></code>
       
   123       </p>
       
   124     </td>
       
   125   </tr>
       
   126 </table>
       
   127 <!-- ==================== STATIC METHODS ==================== -->
       
   128 <a name="section-StaticMethods"></a>
       
   129 <table class="summary" border="1" cellpadding="3"
       
   130        cellspacing="0" width="100%" bgcolor="white">
       
   131 <tr bgcolor="#70b0f0" class="table-header">
       
   132   <td colspan="2" class="table-header">
       
   133     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   134       <tr valign="top">
       
   135         <td align="left"><span class="table-header">Static Methods</span></td>
       
   136         <td align="right" valign="top"
       
   137          ><span class="options">[<a href="#section-StaticMethods"
       
   138          class="privatelink" onclick="toggle_private();"
       
   139          >hide private</a>]</span></td>
       
   140       </tr>
       
   141     </table>
       
   142   </td>
       
   143 </tr>
       
   144 <tr class="private">
       
   145     <td width="15%" align="right" valign="top" class="summary">
       
   146       <span class="summary-type">&nbsp;</span>
       
   147     </td><td class="summary">
       
   148       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   149         <tr>
       
   150           <td><span class="summary-sig"><a name="__commandToXml"></a><span class="summary-sig-name">__commandToXml</span>(<span class="summary-sig-arg">doc</span>,
       
   151         <span class="summary-sig-arg">cmd</span>)</span><br />
       
   152       Convert a Command into an EBS command.</td>
       
   153           <td align="right" valign="top">
       
   154             <span class="codelink"><a href="buildtools-pysrc.html#EBSWriter.__commandToXml">source&nbsp;code</a></span>
       
   155             
       
   156           </td>
       
   157         </tr>
       
   158       </table>
       
   159       
       
   160     </td>
       
   161   </tr>
       
   162 </table>
       
   163 <!-- ==================== METHOD DETAILS ==================== -->
       
   164 <a name="section-MethodDetails"></a>
       
   165 <table class="details" border="1" cellpadding="3"
       
   166        cellspacing="0" width="100%" bgcolor="white">
       
   167 <tr bgcolor="#70b0f0" class="table-header">
       
   168   <td colspan="2" class="table-header">
       
   169     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   170       <tr valign="top">
       
   171         <td align="left"><span class="table-header">Method Details</span></td>
       
   172         <td align="right" valign="top"
       
   173          ><span class="options">[<a href="#section-MethodDetails"
       
   174          class="privatelink" onclick="toggle_private();"
       
   175          >hide private</a>]</span></td>
       
   176       </tr>
       
   177     </table>
       
   178   </td>
       
   179 </tr>
       
   180 </table>
       
   181 <a name="__init__"></a>
       
   182 <div>
       
   183 <table class="details" border="1" cellpadding="3"
       
   184        cellspacing="0" width="100%" bgcolor="white">
       
   185 <tr><td>
       
   186   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   187   <tr valign="top"><td>
       
   188   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   189         <span class="sig-arg">fileOut</span>)</span>
       
   190     <br /><em class="fname">(Constructor)</em>
       
   191   </h3>
       
   192   </td><td align="right" valign="top"
       
   193     ><span class="codelink"><a href="buildtools-pysrc.html#EBSWriter.__init__">source&nbsp;code</a></span>&nbsp;
       
   194     </td>
       
   195   </table>
       
   196   
       
   197   
       
   198   <dl class="fields">
       
   199     <dt>Overrides:
       
   200       <a href="buildtools.AbstractOutputWriter-class.html#__init__">AbstractOutputWriter.__init__</a>
       
   201     </dt>
       
   202   </dl>
       
   203 </td></tr></table>
       
   204 </div>
       
   205 <a name="write"></a>
       
   206 <div>
       
   207 <table class="details" border="1" cellpadding="3"
       
   208        cellspacing="0" width="100%" bgcolor="white">
       
   209 <tr><td>
       
   210   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   211   <tr valign="top"><td>
       
   212   <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
       
   213         <span class="sig-arg">cmdList</span>)</span>
       
   214   </h3>
       
   215   </td><td align="right" valign="top"
       
   216     ><span class="codelink"><a href="buildtools-pysrc.html#EBSWriter.write">source&nbsp;code</a></span>&nbsp;
       
   217     </td>
       
   218   </table>
       
   219   
       
   220   Write the command list to EBS format.
       
   221   <dl class="fields">
       
   222     <dt>Overrides:
       
   223       <a href="buildtools.AbstractOutputWriter-class.html#write">AbstractOutputWriter.write</a>
       
   224     </dt>
       
   225   </dl>
       
   226 </td></tr></table>
       
   227 </div>
       
   228 <br />
       
   229 <!-- ==================== NAVIGATION BAR ==================== -->
       
   230 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   231        bgcolor="#a0c0ff" cellspacing="0">
       
   232   <tr valign="middle">
       
   233 
       
   234   <!-- Tree link -->
       
   235       <th>&nbsp;&nbsp;&nbsp;<a
       
   236         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   237 
       
   238   <!-- Index link -->
       
   239       <th>&nbsp;&nbsp;&nbsp;<a
       
   240         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   241 
       
   242   <!-- Help link -->
       
   243       <th>&nbsp;&nbsp;&nbsp;<a
       
   244         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   245 
       
   246       <th class="navbar" width="100%"></th>
       
   247   </tr>
       
   248 </table>
       
   249 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   250   <tr>
       
   251     <td align="left" class="footer">
       
   252     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   253     </td>
       
   254     <td align="right" class="footer">
       
   255       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   256     </td>
       
   257   </tr>
       
   258 </table>
       
   259 
       
   260 <script type="text/javascript">
       
   261   <!--
       
   262   // Private objects are initially displayed (because if
       
   263   // javascript is turned off then we want them to be
       
   264   // visible); but by default, we want to hide them.  So hide
       
   265   // them unless we have a cookie that says to show them.
       
   266   checkCookie()
       
   267   // -->
       
   268 </script>
       
   269   
       
   270 </body>
       
   271 </html>