doc/api/python/build.model.BOM-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>build.model.BOM</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="build-module.html">Package&nbsp;build</a> ::
       
    38         <a href="build.model-module.html">Module&nbsp;model</a> ::
       
    39         Class&nbsp;BOM
       
    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&nbsp;private</a>]</span></td></tr>
       
    47         <tr><td align="right"><span class="options"
       
    48             >[<a href="frames.html" target="_top">frames</a
       
    49             >]&nbsp;|&nbsp;<a href="build.model.BOM-class.html"
       
    50             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    51       </table>
       
    52     </td>
       
    53   </tr>
       
    54 </table>
       
    55 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    56 <h1 class="epydoc">Class BOM</h1><span class="codelink"><a href="build.model-pysrc.html#BOM">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58 object --+
       
    59          |
       
    60         <strong class="uidshort">BOM</strong>
       
    61 </pre>
       
    62 
       
    63 <hr />
       
    64 The Bill of Materials for a build.<br /><br />
       
    65 
       
    66 <!-- ==================== INSTANCE METHODS ==================== -->
       
    67 <a name="section-InstanceMethods"></a>
       
    68 <table class="summary" border="1" cellpadding="3"
       
    69        cellspacing="0" width="100%" bgcolor="white">
       
    70 <tr bgcolor="#70b0f0" class="table-header">
       
    71   <td colspan="2" class="table-header">
       
    72     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    73       <tr valign="top">
       
    74         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    75         <td align="right" valign="top"
       
    76          ><span class="options">[<a href="#section-InstanceMethods"
       
    77          class="privatelink" onclick="toggle_private();"
       
    78          >hide private</a>]</span></td>
       
    79       </tr>
       
    80     </table>
       
    81   </td>
       
    82 </tr>
       
    83 <tr>
       
    84     <td width="15%" align="right" valign="top" class="summary">
       
    85       <span class="summary-type">&nbsp;</span>
       
    86     </td><td class="summary">
       
    87       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    88         <tr>
       
    89           <td><span class="summary-sig"><a href="build.model.BOM-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    90         <span class="summary-sig-arg">config</span>,
       
    91         <span class="summary-sig-arg">ccm_project</span>=<span class="summary-sig-default">None</span>,
       
    92         <span class="summary-sig-arg">username</span>=<span class="summary-sig-default">None</span>,
       
    93         <span class="summary-sig-arg">password</span>=<span class="summary-sig-default">None</span>,
       
    94         <span class="summary-sig-arg">provider</span>=<span class="summary-sig-default">None</span>)</span><br />
       
    95       Initialization.</td>
       
    96           <td align="right" valign="top">
       
    97             <span class="codelink"><a href="build.model-pysrc.html#BOM.__init__">source&nbsp;code</a></span>
       
    98             
       
    99           </td>
       
   100         </tr>
       
   101       </table>
       
   102       
       
   103     </td>
       
   104   </tr>
       
   105 <tr class="private">
       
   106     <td width="15%" align="right" valign="top" class="summary">
       
   107       <span class="summary-type">&nbsp;</span>
       
   108     </td><td class="summary">
       
   109       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   110         <tr>
       
   111           <td><span class="summary-sig"><a name="_capture_projects"></a><span class="summary-sig-name">_capture_projects</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="build.model-pysrc.html#BOM._capture_projects">source&nbsp;code</a></span>
       
   114             
       
   115           </td>
       
   116         </tr>
       
   117       </table>
       
   118       
       
   119     </td>
       
   120   </tr>
       
   121 <tr class="private">
       
   122     <td width="15%" align="right" valign="top" class="summary">
       
   123       <span class="summary-type">&nbsp;</span>
       
   124     </td><td class="summary">
       
   125       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   126         <tr>
       
   127           <td><span class="summary-sig"><a name="__find_project"></a><span class="summary-sig-name">__find_project</span>(<span class="summary-sig-arg">self</span>,
       
   128         <span class="summary-sig-arg">project</span>,
       
   129         <span class="summary-sig-arg">config</span>)</span></td>
       
   130           <td align="right" valign="top">
       
   131             <span class="codelink"><a href="build.model-pysrc.html#BOM.__find_project">source&nbsp;code</a></span>
       
   132             
       
   133           </td>
       
   134         </tr>
       
   135       </table>
       
   136       
       
   137     </td>
       
   138   </tr>
       
   139 <tr class="private">
       
   140     <td width="15%" align="right" valign="top" class="summary">
       
   141       <span class="summary-type">&nbsp;</span>
       
   142     </td><td class="summary">
       
   143       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   144         <tr>
       
   145           <td><span class="summary-sig"><a name="_capture_icd_icfs"></a><span class="summary-sig-name">_capture_icd_icfs</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   146           <td align="right" valign="top">
       
   147             <span class="codelink"><a href="build.model-pysrc.html#BOM._capture_icd_icfs">source&nbsp;code</a></span>
       
   148             
       
   149           </td>
       
   150         </tr>
       
   151       </table>
       
   152       
       
   153     </td>
       
   154   </tr>
       
   155 <tr class="private">
       
   156     <td width="15%" align="right" valign="top" class="summary">
       
   157       <span class="summary-type">&nbsp;</span>
       
   158     </td><td class="summary">
       
   159       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   160         <tr>
       
   161           <td><span class="summary-sig"><a name="_capture_flags"></a><span class="summary-sig-name">_capture_flags</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   162           <td align="right" valign="top">
       
   163             <span class="codelink"><a href="build.model-pysrc.html#BOM._capture_flags">source&nbsp;code</a></span>
       
   164             
       
   165           </td>
       
   166         </tr>
       
   167       </table>
       
   168       
       
   169     </td>
       
   170   </tr>
       
   171 <tr class="private">
       
   172     <td width="15%" align="right" valign="top" class="summary">
       
   173       <span class="summary-type">&nbsp;</span>
       
   174     </td><td class="summary">
       
   175       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   176         <tr>
       
   177           <td><span class="summary-sig"><a name="_getprojects"></a><span class="summary-sig-name">_getprojects</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   178           <td align="right" valign="top">
       
   179             <span class="codelink"><a href="build.model-pysrc.html#BOM._getprojects">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="projects"></a><span class="summary-sig-name">projects</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   194           <td align="right" valign="top">
       
   195             <span class="codelink"><a href="build.model-pysrc.html#BOM.projects">source&nbsp;code</a></span>
       
   196             
       
   197           </td>
       
   198         </tr>
       
   199       </table>
       
   200       
       
   201     </td>
       
   202   </tr>
       
   203 <tr>
       
   204     <td width="15%" align="right" valign="top" class="summary">
       
   205       <span class="summary-type">&nbsp;</span>
       
   206     </td><td class="summary">
       
   207       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   208         <tr>
       
   209           <td><span class="summary-sig"><a name="all_baselines"></a><span class="summary-sig-name">all_baselines</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   210           <td align="right" valign="top">
       
   211             <span class="codelink"><a href="build.model-pysrc.html#BOM.all_baselines">source&nbsp;code</a></span>
       
   212             
       
   213           </td>
       
   214         </tr>
       
   215       </table>
       
   216       
       
   217     </td>
       
   218   </tr>
       
   219 <tr>
       
   220     <td width="15%" align="right" valign="top" class="summary">
       
   221       <span class="summary-type">&nbsp;</span>
       
   222     </td><td class="summary">
       
   223       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   224         <tr>
       
   225           <td><span class="summary-sig"><a name="all_tasks"></a><span class="summary-sig-name">all_tasks</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   226           <td align="right" valign="top">
       
   227             <span class="codelink"><a href="build.model-pysrc.html#BOM.all_tasks">source&nbsp;code</a></span>
       
   228             
       
   229           </td>
       
   230         </tr>
       
   231       </table>
       
   232       
       
   233     </td>
       
   234   </tr>
       
   235 <tr>
       
   236     <td width="15%" align="right" valign="top" class="summary">
       
   237       <span class="summary-type">&nbsp;</span>
       
   238     </td><td class="summary">
       
   239       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   240         <tr>
       
   241           <td><span class="summary-sig"><a href="build.model.BOM-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
   242       str(x)</td>
       
   243           <td align="right" valign="top">
       
   244             <span class="codelink"><a href="build.model-pysrc.html#BOM.__str__">source&nbsp;code</a></span>
       
   245             
       
   246           </td>
       
   247         </tr>
       
   248       </table>
       
   249       
       
   250     </td>
       
   251   </tr>
       
   252 <tr>
       
   253     <td width="15%" align="right" valign="top" class="summary">
       
   254       <span class="summary-type">&nbsp;</span>
       
   255     </td><td class="summary">
       
   256       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   257         <tr>
       
   258           <td><span class="summary-sig"><a name="close"></a><span class="summary-sig-name">close</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   259           <td align="right" valign="top">
       
   260             <span class="codelink"><a href="build.model-pysrc.html#BOM.close">source&nbsp;code</a></span>
       
   261             
       
   262           </td>
       
   263         </tr>
       
   264       </table>
       
   265       
       
   266     </td>
       
   267   </tr>
       
   268   <tr>
       
   269     <td colspan="2" class="summary">
       
   270     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   271       <code>__delattr__</code>,
       
   272       <code>__getattribute__</code>,
       
   273       <code>__hash__</code>,
       
   274       <code>__new__</code>,
       
   275       <code>__reduce__</code>,
       
   276       <code>__reduce_ex__</code>,
       
   277       <code>__repr__</code>,
       
   278       <code>__setattr__</code>
       
   279       </p>
       
   280     </td>
       
   281   </tr>
       
   282 </table>
       
   283 <!-- ==================== PROPERTIES ==================== -->
       
   284 <a name="section-Properties"></a>
       
   285 <table class="summary" border="1" cellpadding="3"
       
   286        cellspacing="0" width="100%" bgcolor="white">
       
   287 <tr bgcolor="#70b0f0" class="table-header">
       
   288   <td colspan="2" class="table-header">
       
   289     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   290       <tr valign="top">
       
   291         <td align="left"><span class="table-header">Properties</span></td>
       
   292         <td align="right" valign="top"
       
   293          ><span class="options">[<a href="#section-Properties"
       
   294          class="privatelink" onclick="toggle_private();"
       
   295          >hide private</a>]</span></td>
       
   296       </tr>
       
   297     </table>
       
   298   </td>
       
   299 </tr>
       
   300   <tr>
       
   301     <td colspan="2" class="summary">
       
   302     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   303       <code>__class__</code>
       
   304       </p>
       
   305     </td>
       
   306   </tr>
       
   307 </table>
       
   308 <!-- ==================== METHOD DETAILS ==================== -->
       
   309 <a name="section-MethodDetails"></a>
       
   310 <table class="details" border="1" cellpadding="3"
       
   311        cellspacing="0" width="100%" bgcolor="white">
       
   312 <tr bgcolor="#70b0f0" class="table-header">
       
   313   <td colspan="2" class="table-header">
       
   314     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   315       <tr valign="top">
       
   316         <td align="left"><span class="table-header">Method Details</span></td>
       
   317         <td align="right" valign="top"
       
   318          ><span class="options">[<a href="#section-MethodDetails"
       
   319          class="privatelink" onclick="toggle_private();"
       
   320          >hide private</a>]</span></td>
       
   321       </tr>
       
   322     </table>
       
   323   </td>
       
   324 </tr>
       
   325 </table>
       
   326 <a name="__init__"></a>
       
   327 <div>
       
   328 <table class="details" border="1" cellpadding="3"
       
   329        cellspacing="0" width="100%" bgcolor="white">
       
   330 <tr><td>
       
   331   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   332   <tr valign="top"><td>
       
   333   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   334         <span class="sig-arg">config</span>,
       
   335         <span class="sig-arg">ccm_project</span>=<span class="sig-default">None</span>,
       
   336         <span class="sig-arg">username</span>=<span class="sig-default">None</span>,
       
   337         <span class="sig-arg">password</span>=<span class="sig-default">None</span>,
       
   338         <span class="sig-arg">provider</span>=<span class="sig-default">None</span>)</span>
       
   339     <br /><em class="fname">(Constructor)</em>
       
   340   </h3>
       
   341   </td><td align="right" valign="top"
       
   342     ><span class="codelink"><a href="build.model-pysrc.html#BOM.__init__">source&nbsp;code</a></span>&nbsp;
       
   343     </td>
       
   344   </table>
       
   345   
       
   346   Initialization.
       
   347   <dl class="fields">
       
   348     <dt>Parameters:</dt>
       
   349     <dd><ul class="nomargin-top">
       
   350         <li><strong class="pname"><code>config</code></strong> - The build configuration properties.</li>
       
   351         <li><strong class="pname"><code>ccm_project</code></strong> - The Synergy project used for reading the BOM.</li>
       
   352     </ul></dd>
       
   353     <dt>Overrides:
       
   354       object.__init__
       
   355     </dt>
       
   356   </dl>
       
   357 </td></tr></table>
       
   358 </div>
       
   359 <a name="__str__"></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">__str__</span>(<span class="sig-arg">self</span>)</span>
       
   367     <br /><em class="fname">(Informal representation operator)</em>
       
   368   </h3>
       
   369   </td><td align="right" valign="top"
       
   370     ><span class="codelink"><a href="build.model-pysrc.html#BOM.__str__">source&nbsp;code</a></span>&nbsp;
       
   371     </td>
       
   372   </table>
       
   373   
       
   374   str(x)
       
   375   <dl class="fields">
       
   376     <dt>Overrides:
       
   377       object.__str__
       
   378         <dd><em class="note">(inherited documentation)</em></dd>
       
   379     </dt>
       
   380   </dl>
       
   381 </td></tr></table>
       
   382 </div>
       
   383 <br />
       
   384 <!-- ==================== NAVIGATION BAR ==================== -->
       
   385 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   386        bgcolor="#a0c0ff" cellspacing="0">
       
   387   <tr valign="middle">
       
   388 
       
   389   <!-- Tree link -->
       
   390       <th>&nbsp;&nbsp;&nbsp;<a
       
   391         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   392 
       
   393   <!-- Index link -->
       
   394       <th>&nbsp;&nbsp;&nbsp;<a
       
   395         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   396 
       
   397   <!-- Help link -->
       
   398       <th>&nbsp;&nbsp;&nbsp;<a
       
   399         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   400 
       
   401       <th class="navbar" width="100%"></th>
       
   402   </tr>
       
   403 </table>
       
   404 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   405   <tr>
       
   406     <td align="left" class="footer">
       
   407     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   408     </td>
       
   409     <td align="right" class="footer">
       
   410       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   411     </td>
       
   412   </tr>
       
   413 </table>
       
   414 
       
   415 <script type="text/javascript">
       
   416   <!--
       
   417   // Private objects are initially displayed (because if
       
   418   // javascript is turned off then we want them to be
       
   419   // visible); but by default, we want to hide them.  So hide
       
   420   // them unless we have a cookie that says to show them.
       
   421   checkCookie()
       
   422   // -->
       
   423 </script>
       
   424   
       
   425 </body>
       
   426 </html>