doc/api/python/build.model.Project-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.Project</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;Project
       
    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.Project-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 Project</h1><span class="codelink"><a href="build.model-pysrc.html#Project">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58 object --+
       
    59          |
       
    60         <strong class="uidshort">Project</strong>
       
    61 </pre>
       
    62 
       
    63 <hr />
       
    64 <p>An SCM project.</p>
       
    65 <p>An input to the build area, typically copied from an SCM work area.</p><br /><br />
       
    66 
       
    67 <!-- ==================== INSTANCE METHODS ==================== -->
       
    68 <a name="section-InstanceMethods"></a>
       
    69 <table class="summary" border="1" cellpadding="3"
       
    70        cellspacing="0" width="100%" bgcolor="white">
       
    71 <tr bgcolor="#70b0f0" class="table-header">
       
    72   <td colspan="2" class="table-header">
       
    73     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    74       <tr valign="top">
       
    75         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    76         <td align="right" valign="top"
       
    77          ><span class="options">[<a href="#section-InstanceMethods"
       
    78          class="privatelink" onclick="toggle_private();"
       
    79          >hide private</a>]</span></td>
       
    80       </tr>
       
    81     </table>
       
    82   </td>
       
    83 </tr>
       
    84 <tr>
       
    85     <td width="15%" align="right" valign="top" class="summary">
       
    86       <span class="summary-type">&nbsp;</span>
       
    87     </td><td class="summary">
       
    88       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    89         <tr>
       
    90           <td><span class="summary-sig"><a href="build.model.Project-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    91         <span class="summary-sig-arg">ccm_project</span>,
       
    92         <span class="summary-sig-arg">config</span>,
       
    93         <span class="summary-sig-arg">action</span>=<span class="summary-sig-default">None</span>)</span><br />
       
    94       Initialisation.</td>
       
    95           <td align="right" valign="top">
       
    96             <span class="codelink"><a href="build.model-pysrc.html#Project.__init__">source&nbsp;code</a></span>
       
    97             
       
    98           </td>
       
    99         </tr>
       
   100       </table>
       
   101       
       
   102     </td>
       
   103   </tr>
       
   104 <tr class="private">
       
   105     <td width="15%" align="right" valign="top" class="summary">
       
   106       <span class="summary-type">&nbsp;</span>
       
   107     </td><td class="summary">
       
   108       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   109         <tr>
       
   110           <td><span class="summary-sig"><a name="_import_baseline_config"></a><span class="summary-sig-name">_import_baseline_config</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   111       Import the baseline folders and tasks.</td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="build.model-pysrc.html#Project._import_baseline_config">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="_get_toplevel_baselines"></a><span class="summary-sig-name">_get_toplevel_baselines</span>(<span class="summary-sig-arg">self</span>,
       
   128         <span class="summary-sig-arg">project</span>)</span></td>
       
   129           <td align="right" valign="top">
       
   130             <span class="codelink"><a href="build.model-pysrc.html#Project._get_toplevel_baselines">source&nbsp;code</a></span>
       
   131             
       
   132           </td>
       
   133         </tr>
       
   134       </table>
       
   135       
       
   136     </td>
       
   137   </tr>
       
   138 <tr class="private">
       
   139     <td width="15%" align="right" valign="top" class="summary">
       
   140       <span class="summary-type">&nbsp;</span>
       
   141     </td><td class="summary">
       
   142       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   143         <tr>
       
   144           <td><span class="summary-sig"><a name="_getbaselines"></a><span class="summary-sig-name">_getbaselines</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   145           <td align="right" valign="top">
       
   146             <span class="codelink"><a href="build.model-pysrc.html#Project._getbaselines">source&nbsp;code</a></span>
       
   147             
       
   148           </td>
       
   149         </tr>
       
   150       </table>
       
   151       
       
   152     </td>
       
   153   </tr>
       
   154 <tr>
       
   155     <td width="15%" align="right" valign="top" class="summary">
       
   156       <span class="summary-type">&nbsp;</span>
       
   157     </td><td class="summary">
       
   158       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   159         <tr>
       
   160           <td><span class="summary-sig"><a name="baselines"></a><span class="summary-sig-name">baselines</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   161           <td align="right" valign="top">
       
   162             <span class="codelink"><a href="build.model-pysrc.html#Project.baselines">source&nbsp;code</a></span>
       
   163             
       
   164           </td>
       
   165         </tr>
       
   166       </table>
       
   167       
       
   168     </td>
       
   169   </tr>
       
   170 <tr class="private">
       
   171     <td width="15%" align="right" valign="top" class="summary">
       
   172       <span class="summary-type">&nbsp;</span>
       
   173     </td><td class="summary">
       
   174       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   175         <tr>
       
   176           <td><span class="summary-sig"><a name="_getfolders"></a><span class="summary-sig-name">_getfolders</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   177           <td align="right" valign="top">
       
   178             <span class="codelink"><a href="build.model-pysrc.html#Project._getfolders">source&nbsp;code</a></span>
       
   179             
       
   180           </td>
       
   181         </tr>
       
   182       </table>
       
   183       
       
   184     </td>
       
   185   </tr>
       
   186 <tr>
       
   187     <td width="15%" align="right" valign="top" class="summary">
       
   188       <span class="summary-type">&nbsp;</span>
       
   189     </td><td class="summary">
       
   190       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   191         <tr>
       
   192           <td><span class="summary-sig"><a name="folders"></a><span class="summary-sig-name">folders</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   193           <td align="right" valign="top">
       
   194             <span class="codelink"><a href="build.model-pysrc.html#Project.folders">source&nbsp;code</a></span>
       
   195             
       
   196           </td>
       
   197         </tr>
       
   198       </table>
       
   199       
       
   200     </td>
       
   201   </tr>
       
   202 <tr>
       
   203     <td width="15%" align="right" valign="top" class="summary">
       
   204       <span class="summary-type">&nbsp;</span>
       
   205     </td><td class="summary">
       
   206       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   207         <tr>
       
   208           <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><br />
       
   209       Get all the tasks (individual and folder based).</td>
       
   210           <td align="right" valign="top">
       
   211             <span class="codelink"><a href="build.model-pysrc.html#Project.all_tasks">source&nbsp;code</a></span>
       
   212             
       
   213           </td>
       
   214         </tr>
       
   215       </table>
       
   216       
       
   217     </td>
       
   218   </tr>
       
   219 <tr class="private">
       
   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="_gettasks"></a><span class="summary-sig-name">_gettasks</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#Project._gettasks">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 name="tasks"></a><span class="summary-sig-name">tasks</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   242           <td align="right" valign="top">
       
   243             <span class="codelink"><a href="build.model-pysrc.html#Project.tasks">source&nbsp;code</a></span>
       
   244             
       
   245           </td>
       
   246         </tr>
       
   247       </table>
       
   248       
       
   249     </td>
       
   250   </tr>
       
   251 <tr class="private">
       
   252     <td width="15%" align="right" valign="top" class="summary">
       
   253       <span class="summary-type">&nbsp;</span>
       
   254     </td><td class="summary">
       
   255       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   256         <tr>
       
   257           <td><span class="summary-sig"><a name="_getsupplier"></a><span class="summary-sig-name">_getsupplier</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   258           <td align="right" valign="top">
       
   259             <span class="codelink"><a href="build.model-pysrc.html#Project._getsupplier">source&nbsp;code</a></span>
       
   260             
       
   261           </td>
       
   262         </tr>
       
   263       </table>
       
   264       
       
   265     </td>
       
   266   </tr>
       
   267 <tr>
       
   268     <td width="15%" align="right" valign="top" class="summary">
       
   269       <span class="summary-type">&nbsp;</span>
       
   270     </td><td class="summary">
       
   271       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   272         <tr>
       
   273           <td><span class="summary-sig"><a name="supplier"></a><span class="summary-sig-name">supplier</span>(<span class="summary-sig-arg">self</span>)</span></td>
       
   274           <td align="right" valign="top">
       
   275             <span class="codelink"><a href="build.model-pysrc.html#Project.supplier">source&nbsp;code</a></span>
       
   276             
       
   277           </td>
       
   278         </tr>
       
   279       </table>
       
   280       
       
   281     </td>
       
   282   </tr>
       
   283 <tr>
       
   284     <td width="15%" align="right" valign="top" class="summary">
       
   285       <span class="summary-type">&nbsp;</span>
       
   286     </td><td class="summary">
       
   287       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   288         <tr>
       
   289           <td><span class="summary-sig"><a href="build.model.Project-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
   290       Object representation.</td>
       
   291           <td align="right" valign="top">
       
   292             <span class="codelink"><a href="build.model-pysrc.html#Project.__repr__">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 href="build.model.Project-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
   307       String representation.</td>
       
   308           <td align="right" valign="top">
       
   309             <span class="codelink"><a href="build.model-pysrc.html#Project.__str__">source&nbsp;code</a></span>
       
   310             
       
   311           </td>
       
   312         </tr>
       
   313       </table>
       
   314       
       
   315     </td>
       
   316   </tr>
       
   317   <tr>
       
   318     <td colspan="2" class="summary">
       
   319     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   320       <code>__delattr__</code>,
       
   321       <code>__getattribute__</code>,
       
   322       <code>__hash__</code>,
       
   323       <code>__new__</code>,
       
   324       <code>__reduce__</code>,
       
   325       <code>__reduce_ex__</code>,
       
   326       <code>__setattr__</code>
       
   327       </p>
       
   328     </td>
       
   329   </tr>
       
   330 </table>
       
   331 <!-- ==================== PROPERTIES ==================== -->
       
   332 <a name="section-Properties"></a>
       
   333 <table class="summary" border="1" cellpadding="3"
       
   334        cellspacing="0" width="100%" bgcolor="white">
       
   335 <tr bgcolor="#70b0f0" class="table-header">
       
   336   <td colspan="2" class="table-header">
       
   337     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   338       <tr valign="top">
       
   339         <td align="left"><span class="table-header">Properties</span></td>
       
   340         <td align="right" valign="top"
       
   341          ><span class="options">[<a href="#section-Properties"
       
   342          class="privatelink" onclick="toggle_private();"
       
   343          >hide private</a>]</span></td>
       
   344       </tr>
       
   345     </table>
       
   346   </td>
       
   347 </tr>
       
   348   <tr>
       
   349     <td colspan="2" class="summary">
       
   350     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   351       <code>__class__</code>
       
   352       </p>
       
   353     </td>
       
   354   </tr>
       
   355 </table>
       
   356 <!-- ==================== METHOD DETAILS ==================== -->
       
   357 <a name="section-MethodDetails"></a>
       
   358 <table class="details" border="1" cellpadding="3"
       
   359        cellspacing="0" width="100%" bgcolor="white">
       
   360 <tr bgcolor="#70b0f0" class="table-header">
       
   361   <td colspan="2" class="table-header">
       
   362     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   363       <tr valign="top">
       
   364         <td align="left"><span class="table-header">Method Details</span></td>
       
   365         <td align="right" valign="top"
       
   366          ><span class="options">[<a href="#section-MethodDetails"
       
   367          class="privatelink" onclick="toggle_private();"
       
   368          >hide private</a>]</span></td>
       
   369       </tr>
       
   370     </table>
       
   371   </td>
       
   372 </tr>
       
   373 </table>
       
   374 <a name="__init__"></a>
       
   375 <div>
       
   376 <table class="details" border="1" cellpadding="3"
       
   377        cellspacing="0" width="100%" bgcolor="white">
       
   378 <tr><td>
       
   379   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   380   <tr valign="top"><td>
       
   381   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   382         <span class="sig-arg">ccm_project</span>,
       
   383         <span class="sig-arg">config</span>,
       
   384         <span class="sig-arg">action</span>=<span class="sig-default">None</span>)</span>
       
   385     <br /><em class="fname">(Constructor)</em>
       
   386   </h3>
       
   387   </td><td align="right" valign="top"
       
   388     ><span class="codelink"><a href="build.model-pysrc.html#Project.__init__">source&nbsp;code</a></span>&nbsp;
       
   389     </td>
       
   390   </table>
       
   391   
       
   392   Initialisation.
       
   393   <dl class="fields">
       
   394     <dt>Overrides:
       
   395       object.__init__
       
   396     </dt>
       
   397   </dl>
       
   398 </td></tr></table>
       
   399 </div>
       
   400 <a name="__repr__"></a>
       
   401 <div>
       
   402 <table class="details" border="1" cellpadding="3"
       
   403        cellspacing="0" width="100%" bgcolor="white">
       
   404 <tr><td>
       
   405   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   406   <tr valign="top"><td>
       
   407   <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
       
   408     <br /><em class="fname">(Representation operator)</em>
       
   409   </h3>
       
   410   </td><td align="right" valign="top"
       
   411     ><span class="codelink"><a href="build.model-pysrc.html#Project.__repr__">source&nbsp;code</a></span>&nbsp;
       
   412     </td>
       
   413   </table>
       
   414   
       
   415   Object representation.
       
   416   <dl class="fields">
       
   417     <dt>Overrides:
       
   418       object.__repr__
       
   419     </dt>
       
   420   </dl>
       
   421 </td></tr></table>
       
   422 </div>
       
   423 <a name="__str__"></a>
       
   424 <div>
       
   425 <table class="details" border="1" cellpadding="3"
       
   426        cellspacing="0" width="100%" bgcolor="white">
       
   427 <tr><td>
       
   428   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   429   <tr valign="top"><td>
       
   430   <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
       
   431     <br /><em class="fname">(Informal representation operator)</em>
       
   432   </h3>
       
   433   </td><td align="right" valign="top"
       
   434     ><span class="codelink"><a href="build.model-pysrc.html#Project.__str__">source&nbsp;code</a></span>&nbsp;
       
   435     </td>
       
   436   </table>
       
   437   
       
   438   String representation.
       
   439   <dl class="fields">
       
   440     <dt>Overrides:
       
   441       object.__str__
       
   442     </dt>
       
   443   </dl>
       
   444 </td></tr></table>
       
   445 </div>
       
   446 <br />
       
   447 <!-- ==================== NAVIGATION BAR ==================== -->
       
   448 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   449        bgcolor="#a0c0ff" cellspacing="0">
       
   450   <tr valign="middle">
       
   451 
       
   452   <!-- Tree link -->
       
   453       <th>&nbsp;&nbsp;&nbsp;<a
       
   454         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   455 
       
   456   <!-- Index link -->
       
   457       <th>&nbsp;&nbsp;&nbsp;<a
       
   458         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   459 
       
   460   <!-- Help link -->
       
   461       <th>&nbsp;&nbsp;&nbsp;<a
       
   462         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   463 
       
   464       <th class="navbar" width="100%"></th>
       
   465   </tr>
       
   466 </table>
       
   467 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   468   <tr>
       
   469     <td align="left" class="footer">
       
   470     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   471     </td>
       
   472     <td align="right" class="footer">
       
   473       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   474     </td>
       
   475   </tr>
       
   476 </table>
       
   477 
       
   478 <script type="text/javascript">
       
   479   <!--
       
   480   // Private objects are initially displayed (because if
       
   481   // javascript is turned off then we want them to be
       
   482   // visible); but by default, we want to hide them.  So hide
       
   483   // them unless we have a cookie that says to show them.
       
   484   checkCookie()
       
   485   // -->
       
   486 </script>
       
   487   
       
   488 </body>
       
   489 </html>