doc/api/python/ccm.conflict-module.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>ccm.conflict</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="ccm-module.html">Package&nbsp;ccm</a> ::
       
    38         Module&nbsp;conflict
       
    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="ccm.conflict-module.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Module conflict</h1><span class="codelink"><a href="ccm.conflict-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    56 CCM conflict detection module.<br /><br />
       
    57 
       
    58 <!-- ==================== CLASSES ==================== -->
       
    59 <a name="section-Classes"></a>
       
    60 <table class="summary" border="1" cellpadding="3"
       
    61        cellspacing="0" width="100%" bgcolor="white">
       
    62 <tr bgcolor="#70b0f0" class="table-header">
       
    63   <td colspan="2" class="table-header">
       
    64     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    65       <tr valign="top">
       
    66         <td align="left"><span class="table-header">Classes</span></td>
       
    67         <td align="right" valign="top"
       
    68          ><span class="options">[<a href="#section-Classes"
       
    69          class="privatelink" onclick="toggle_private();"
       
    70          >hide private</a>]</span></td>
       
    71       </tr>
       
    72     </table>
       
    73   </td>
       
    74 </tr>
       
    75 <tr>
       
    76     <td width="15%" align="right" valign="top" class="summary">
       
    77       <span class="summary-type">&nbsp;</span>
       
    78     </td><td class="summary">
       
    79         <a href="ccm.conflict.ObjectAndTask-class.html" class="summary-name">ObjectAndTask</a><br />
       
    80       Wrapper object which link an object to a task.
       
    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         <a href="ccm.conflict.TaskModel-class.html" class="summary-name">TaskModel</a><br />
       
    88       Task wrapper object which contains objectandtask object.
       
    89     </td>
       
    90   </tr>
       
    91 <tr>
       
    92     <td width="15%" align="right" valign="top" class="summary">
       
    93       <span class="summary-type">&nbsp;</span>
       
    94     </td><td class="summary">
       
    95         <a href="ccm.conflict.Conflict-class.html" class="summary-name">Conflict</a>
       
    96     </td>
       
    97   </tr>
       
    98 <tr>
       
    99     <td width="15%" align="right" valign="top" class="summary">
       
   100       <span class="summary-type">&nbsp;</span>
       
   101     </td><td class="summary">
       
   102         <a href="ccm.conflict.MultipleObjectInBaselineConflict-class.html" class="summary-name">MultipleObjectInBaselineConflict</a>
       
   103     </td>
       
   104   </tr>
       
   105 <tr>
       
   106     <td width="15%" align="right" valign="top" class="summary">
       
   107       <span class="summary-type">&nbsp;</span>
       
   108     </td><td class="summary">
       
   109         <a href="ccm.conflict.ObjectAndBaselineConflict-class.html" class="summary-name">ObjectAndBaselineConflict</a>
       
   110     </td>
       
   111   </tr>
       
   112 <tr>
       
   113     <td width="15%" align="right" valign="top" class="summary">
       
   114       <span class="summary-type">&nbsp;</span>
       
   115     </td><td class="summary">
       
   116         <a href="ccm.conflict.ObjectNotFoundInBaselineConflict-class.html" class="summary-name">ObjectNotFoundInBaselineConflict</a>
       
   117     </td>
       
   118   </tr>
       
   119 </table>
       
   120 <!-- ==================== FUNCTIONS ==================== -->
       
   121 <a name="section-Functions"></a>
       
   122 <table class="summary" border="1" cellpadding="3"
       
   123        cellspacing="0" width="100%" bgcolor="white">
       
   124 <tr bgcolor="#70b0f0" class="table-header">
       
   125   <td colspan="2" class="table-header">
       
   126     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   127       <tr valign="top">
       
   128         <td align="left"><span class="table-header">Functions</span></td>
       
   129         <td align="right" valign="top"
       
   130          ><span class="options">[<a href="#section-Functions"
       
   131          class="privatelink" onclick="toggle_private();"
       
   132          >hide private</a>]</span></td>
       
   133       </tr>
       
   134     </table>
       
   135   </td>
       
   136 </tr>
       
   137 <tr>
       
   138     <td width="15%" align="right" valign="top" class="summary">
       
   139       <span class="summary-type">&nbsp;</span>
       
   140     </td><td class="summary">
       
   141       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   142         <tr>
       
   143           <td><span class="summary-sig"><a name="get_tasks_from_project"></a><span class="summary-sig-name">get_tasks_from_project</span>(<span class="summary-sig-arg">project</span>)</span></td>
       
   144           <td align="right" valign="top">
       
   145             <span class="codelink"><a href="ccm.conflict-pysrc.html#get_tasks_from_project">source&nbsp;code</a></span>
       
   146             
       
   147           </td>
       
   148         </tr>
       
   149       </table>
       
   150       
       
   151     </td>
       
   152   </tr>
       
   153 <tr>
       
   154     <td width="15%" align="right" valign="top" class="summary">
       
   155       <span class="summary-type">&nbsp;</span>
       
   156     </td><td class="summary">
       
   157       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   158         <tr>
       
   159           <td><span class="summary-sig"><a name="get_tasks_information_from_project"></a><span class="summary-sig-name">get_tasks_information_from_project</span>(<span class="summary-sig-arg">project</span>)</span></td>
       
   160           <td align="right" valign="top">
       
   161             <span class="codelink"><a href="ccm.conflict-pysrc.html#get_tasks_information_from_project">source&nbsp;code</a></span>
       
   162             
       
   163           </td>
       
   164         </tr>
       
   165       </table>
       
   166       
       
   167     </td>
       
   168   </tr>
       
   169 <tr>
       
   170     <td width="15%" align="right" valign="top" class="summary">
       
   171       <span class="summary-type">&nbsp;</span>
       
   172     </td><td class="summary">
       
   173       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   174         <tr>
       
   175           <td><span class="summary-sig"><a href="ccm.conflict-module.html#get_tasks_information" class="summary-sig-name">get_tasks_information</a>(<span class="summary-sig-arg">folder</span>)</span><br />
       
   176       Get tasks from folder.</td>
       
   177           <td align="right" valign="top">
       
   178             <span class="codelink"><a href="ccm.conflict-pysrc.html#get_tasks_information">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 href="ccm.conflict-module.html#get_tasks" class="summary-sig-name">get_tasks</a>(<span class="summary-sig-arg">folder</span>)</span><br />
       
   193       Get tasks from folder.</td>
       
   194           <td align="right" valign="top">
       
   195             <span class="codelink"><a href="ccm.conflict-pysrc.html#get_tasks">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="tasks_to_objectandtask"></a><span class="summary-sig-name">tasks_to_objectandtask</span>(<span class="summary-sig-arg">tasks</span>)</span></td>
       
   210           <td align="right" valign="top">
       
   211             <span class="codelink"><a href="ccm.conflict-pysrc.html#tasks_to_objectandtask">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="tasks_to_families_and_taskmodels"></a><span class="summary-sig-name">tasks_to_families_and_taskmodels</span>(<span class="summary-sig-arg">tasks</span>,
       
   226         <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">1</span>)</span></td>
       
   227           <td align="right" valign="top">
       
   228             <span class="codelink"><a href="ccm.conflict-pysrc.html#tasks_to_families_and_taskmodels">source&nbsp;code</a></span>
       
   229             
       
   230           </td>
       
   231         </tr>
       
   232       </table>
       
   233       
       
   234     </td>
       
   235   </tr>
       
   236 <tr>
       
   237     <td width="15%" align="right" valign="top" class="summary">
       
   238       <span class="summary-type">&nbsp;</span>
       
   239     </td><td class="summary">
       
   240       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   241         <tr>
       
   242           <td><span class="summary-sig"><a href="ccm.conflict-module.html#check_task_conflicts" class="summary-sig-name">check_task_conflicts</a>(<span class="summary-sig-arg">tasks</span>,
       
   243         <span class="summary-sig-arg">size</span>=<span class="summary-sig-default">1</span>)</span><br />
       
   244       Validates objects a list of task.</td>
       
   245           <td align="right" valign="top">
       
   246             <span class="codelink"><a href="ccm.conflict-pysrc.html#check_task_conflicts">source&nbsp;code</a></span>
       
   247             
       
   248           </td>
       
   249         </tr>
       
   250       </table>
       
   251       
       
   252     </td>
       
   253   </tr>
       
   254 <tr>
       
   255     <td width="15%" align="right" valign="top" class="summary">
       
   256       <span class="summary-type">&nbsp;</span>
       
   257     </td><td class="summary">
       
   258       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   259         <tr>
       
   260           <td><span class="summary-sig"><a href="ccm.conflict-module.html#check_task_and_baseline_conflicts" class="summary-sig-name">check_task_and_baseline_conflicts</a>(<span class="summary-sig-arg">tasks</span>,
       
   261         <span class="summary-sig-arg">baseline</span>)</span><br />
       
   262       Validates objects a list of task.</td>
       
   263           <td align="right" valign="top">
       
   264             <span class="codelink"><a href="ccm.conflict-pysrc.html#check_task_and_baseline_conflicts">source&nbsp;code</a></span>
       
   265             
       
   266           </td>
       
   267         </tr>
       
   268       </table>
       
   269       
       
   270     </td>
       
   271   </tr>
       
   272 </table>
       
   273 <!-- ==================== FUNCTION DETAILS ==================== -->
       
   274 <a name="section-FunctionDetails"></a>
       
   275 <table class="details" border="1" cellpadding="3"
       
   276        cellspacing="0" width="100%" bgcolor="white">
       
   277 <tr bgcolor="#70b0f0" class="table-header">
       
   278   <td colspan="2" class="table-header">
       
   279     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   280       <tr valign="top">
       
   281         <td align="left"><span class="table-header">Function Details</span></td>
       
   282         <td align="right" valign="top"
       
   283          ><span class="options">[<a href="#section-FunctionDetails"
       
   284          class="privatelink" onclick="toggle_private();"
       
   285          >hide private</a>]</span></td>
       
   286       </tr>
       
   287     </table>
       
   288   </td>
       
   289 </tr>
       
   290 </table>
       
   291 <a name="get_tasks_information"></a>
       
   292 <div>
       
   293 <table class="details" border="1" cellpadding="3"
       
   294        cellspacing="0" width="100%" bgcolor="white">
       
   295 <tr><td>
       
   296   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   297   <tr valign="top"><td>
       
   298   <h3 class="epydoc"><span class="sig"><span class="sig-name">get_tasks_information</span>(<span class="sig-arg">folder</span>)</span>
       
   299   </h3>
       
   300   </td><td align="right" valign="top"
       
   301     ><span class="codelink"><a href="ccm.conflict-pysrc.html#get_tasks_information">source&nbsp;code</a></span>&nbsp;
       
   302     </td>
       
   303   </table>
       
   304   
       
   305   Get tasks from folder. If the folder is query based it uses the query to determine the list of task.
       
   306 But the folder contents itself remains untouch.
       
   307   <dl class="fields">
       
   308   </dl>
       
   309 </td></tr></table>
       
   310 </div>
       
   311 <a name="get_tasks"></a>
       
   312 <div>
       
   313 <table class="details" border="1" cellpadding="3"
       
   314        cellspacing="0" width="100%" bgcolor="white">
       
   315 <tr><td>
       
   316   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   317   <tr valign="top"><td>
       
   318   <h3 class="epydoc"><span class="sig"><span class="sig-name">get_tasks</span>(<span class="sig-arg">folder</span>)</span>
       
   319   </h3>
       
   320   </td><td align="right" valign="top"
       
   321     ><span class="codelink"><a href="ccm.conflict-pysrc.html#get_tasks">source&nbsp;code</a></span>&nbsp;
       
   322     </td>
       
   323   </table>
       
   324   
       
   325   Get tasks from folder. If the folder is query based it uses the query to determine the list of task.
       
   326 But the folder contents itself remains untouch.
       
   327   <dl class="fields">
       
   328   </dl>
       
   329 </td></tr></table>
       
   330 </div>
       
   331 <a name="check_task_conflicts"></a>
       
   332 <div>
       
   333 <table class="details" border="1" cellpadding="3"
       
   334        cellspacing="0" width="100%" bgcolor="white">
       
   335 <tr><td>
       
   336   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   337   <tr valign="top"><td>
       
   338   <h3 class="epydoc"><span class="sig"><span class="sig-name">check_task_conflicts</span>(<span class="sig-arg">tasks</span>,
       
   339         <span class="sig-arg">size</span>=<span class="sig-default">1</span>)</span>
       
   340   </h3>
       
   341   </td><td align="right" valign="top"
       
   342     ><span class="codelink"><a href="ccm.conflict-pysrc.html#check_task_conflicts">source&nbsp;code</a></span>&nbsp;
       
   343     </td>
       
   344   </table>
       
   345   
       
   346   Validates objects a list of task.
       
   347 It returns a list of list of conflicting ObjectAndTask.
       
   348   <dl class="fields">
       
   349   </dl>
       
   350 </td></tr></table>
       
   351 </div>
       
   352 <a name="check_task_and_baseline_conflicts"></a>
       
   353 <div>
       
   354 <table class="details" border="1" cellpadding="3"
       
   355        cellspacing="0" width="100%" bgcolor="white">
       
   356 <tr><td>
       
   357   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   358   <tr valign="top"><td>
       
   359   <h3 class="epydoc"><span class="sig"><span class="sig-name">check_task_and_baseline_conflicts</span>(<span class="sig-arg">tasks</span>,
       
   360         <span class="sig-arg">baseline</span>)</span>
       
   361   </h3>
       
   362   </td><td align="right" valign="top"
       
   363     ><span class="codelink"><a href="ccm.conflict-pysrc.html#check_task_and_baseline_conflicts">source&nbsp;code</a></span>&nbsp;
       
   364     </td>
       
   365   </table>
       
   366   
       
   367   Validates objects a list of task.
       
   368 It returns a list of list of conflicting ObjectAndTask.
       
   369   <dl class="fields">
       
   370   </dl>
       
   371 </td></tr></table>
       
   372 </div>
       
   373 <br />
       
   374 <!-- ==================== NAVIGATION BAR ==================== -->
       
   375 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   376        bgcolor="#a0c0ff" cellspacing="0">
       
   377   <tr valign="middle">
       
   378 
       
   379   <!-- Tree link -->
       
   380       <th>&nbsp;&nbsp;&nbsp;<a
       
   381         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   382 
       
   383   <!-- Index link -->
       
   384       <th>&nbsp;&nbsp;&nbsp;<a
       
   385         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   386 
       
   387   <!-- Help link -->
       
   388       <th>&nbsp;&nbsp;&nbsp;<a
       
   389         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   390 
       
   391       <th class="navbar" width="100%"></th>
       
   392   </tr>
       
   393 </table>
       
   394 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   395   <tr>
       
   396     <td align="left" class="footer">
       
   397     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   398     </td>
       
   399     <td align="right" class="footer">
       
   400       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   401     </td>
       
   402   </tr>
       
   403 </table>
       
   404 
       
   405 <script type="text/javascript">
       
   406   <!--
       
   407   // Private objects are initially displayed (because if
       
   408   // javascript is turned off then we want them to be
       
   409   // visible); but by default, we want to hide them.  So hide
       
   410   // them unless we have a cookie that says to show them.
       
   411   checkCookie()
       
   412   // -->
       
   413 </script>
       
   414   
       
   415 </body>
       
   416 </html>