doc/api/python/ccm.ProjectCheckoutResult-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>ccm.ProjectCheckoutResult</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         Class&nbsp;ProjectCheckoutResult
       
    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.ProjectCheckoutResult-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 ProjectCheckoutResult</h1><span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 object --+    
       
    58          |    
       
    59     <a href="ccm.Result-class.html">Result</a> --+
       
    60              |
       
    61             <strong class="uidshort">ProjectCheckoutResult</strong>
       
    62 </pre>
       
    63 
       
    64 <hr />
       
    65 Project checkout output parser.
       
    66 Sets project to the created project or None if failed.<br /><br />
       
    67 
       
    68 <!-- ==================== INSTANCE METHODS ==================== -->
       
    69 <a name="section-InstanceMethods"></a>
       
    70 <table class="summary" border="1" cellpadding="3"
       
    71        cellspacing="0" width="100%" bgcolor="white">
       
    72 <tr bgcolor="#70b0f0" class="table-header">
       
    73   <td colspan="2" class="table-header">
       
    74     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    75       <tr valign="top">
       
    76         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    77         <td align="right" valign="top"
       
    78          ><span class="options">[<a href="#section-InstanceMethods"
       
    79          class="privatelink" onclick="toggle_private();"
       
    80          >hide private</a>]</span></td>
       
    81       </tr>
       
    82     </table>
       
    83   </td>
       
    84 </tr>
       
    85 <tr>
       
    86     <td width="15%" align="right" valign="top" class="summary">
       
    87       <span class="summary-type">&nbsp;</span>
       
    88     </td><td class="summary">
       
    89       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    90         <tr>
       
    91           <td><span class="summary-sig"><a href="ccm.ProjectCheckoutResult-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    92         <span class="summary-sig-arg">session</span>,
       
    93         <span class="summary-sig-arg">project</span>)</span></td>
       
    94           <td align="right" valign="top">
       
    95             <span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult.__init__">source&nbsp;code</a></span>
       
    96             
       
    97           </td>
       
    98         </tr>
       
    99       </table>
       
   100       
       
   101     </td>
       
   102   </tr>
       
   103 <tr class="private">
       
   104     <td width="15%" align="right" valign="top" class="summary">
       
   105       <span class="summary-type">&nbsp;</span>
       
   106     </td><td class="summary">
       
   107       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   108         <tr>
       
   109           <td><span class="summary-sig"><a href="ccm.ProjectCheckoutResult-class.html#_setoutput" class="summary-sig-name">_setoutput</a>(<span class="summary-sig-arg">self</span>,
       
   110         <span class="summary-sig-arg">output</span>)</span><br />
       
   111       Parsing the output of the checkout command.</td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult._setoutput">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_result_project"></a><span class="summary-sig-name">__get_result_project</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   128       return the checked out project.</td>
       
   129           <td align="right" valign="top">
       
   130             <span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult.__get_result_project">source&nbsp;code</a></span>
       
   131             
       
   132           </td>
       
   133         </tr>
       
   134       </table>
       
   135       
       
   136     </td>
       
   137   </tr>
       
   138 <tr>
       
   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="project"></a><span class="summary-sig-name">project</span>(<span class="summary-sig-arg">self</span>)</span><br />
       
   145       return the checked out project.</td>
       
   146           <td align="right" valign="top">
       
   147             <span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult.project">source&nbsp;code</a></span>
       
   148             
       
   149           </td>
       
   150         </tr>
       
   151       </table>
       
   152       
       
   153     </td>
       
   154   </tr>
       
   155   <tr>
       
   156     <td colspan="2" class="summary">
       
   157     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.Result-class.html">Result</a></code></b>:
       
   158       <code><a href="ccm.Result-class.html#__str__">__str__</a></code>
       
   159       </p>
       
   160     <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.Result-class.html">Result</a></code></b> (private):
       
   161       <code><a href="ccm.Result-class.html#_getoutput">_getoutput</a></code>
       
   162       </p></div>
       
   163     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   164       <code>__delattr__</code>,
       
   165       <code>__getattribute__</code>,
       
   166       <code>__hash__</code>,
       
   167       <code>__new__</code>,
       
   168       <code>__reduce__</code>,
       
   169       <code>__reduce_ex__</code>,
       
   170       <code>__repr__</code>,
       
   171       <code>__setattr__</code>
       
   172       </p>
       
   173     </td>
       
   174   </tr>
       
   175 </table>
       
   176 <!-- ==================== CLASS VARIABLES ==================== -->
       
   177 <a name="section-ClassVariables"></a>
       
   178 <table class="summary" border="1" cellpadding="3"
       
   179        cellspacing="0" width="100%" bgcolor="white">
       
   180 <tr bgcolor="#70b0f0" class="table-header">
       
   181   <td colspan="2" class="table-header">
       
   182     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   183       <tr valign="top">
       
   184         <td align="left"><span class="table-header">Class Variables</span></td>
       
   185         <td align="right" valign="top"
       
   186          ><span class="options">[<a href="#section-ClassVariables"
       
   187          class="privatelink" onclick="toggle_private();"
       
   188          >hide private</a>]</span></td>
       
   189       </tr>
       
   190     </table>
       
   191   </td>
       
   192 </tr>
       
   193   <tr>
       
   194     <td colspan="2" class="summary">
       
   195     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.Result-class.html">Result</a></code></b>:
       
   196       <code><a href="ccm.Result-class.html#output">output</a></code>
       
   197       </p>
       
   198     </td>
       
   199   </tr>
       
   200 </table>
       
   201 <!-- ==================== PROPERTIES ==================== -->
       
   202 <a name="section-Properties"></a>
       
   203 <table class="summary" border="1" cellpadding="3"
       
   204        cellspacing="0" width="100%" bgcolor="white">
       
   205 <tr bgcolor="#70b0f0" class="table-header">
       
   206   <td colspan="2" class="table-header">
       
   207     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   208       <tr valign="top">
       
   209         <td align="left"><span class="table-header">Properties</span></td>
       
   210         <td align="right" valign="top"
       
   211          ><span class="options">[<a href="#section-Properties"
       
   212          class="privatelink" onclick="toggle_private();"
       
   213          >hide private</a>]</span></td>
       
   214       </tr>
       
   215     </table>
       
   216   </td>
       
   217 </tr>
       
   218   <tr>
       
   219     <td colspan="2" class="summary">
       
   220     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   221       <code>__class__</code>
       
   222       </p>
       
   223     </td>
       
   224   </tr>
       
   225 </table>
       
   226 <!-- ==================== METHOD DETAILS ==================== -->
       
   227 <a name="section-MethodDetails"></a>
       
   228 <table class="details" border="1" cellpadding="3"
       
   229        cellspacing="0" width="100%" bgcolor="white">
       
   230 <tr bgcolor="#70b0f0" class="table-header">
       
   231   <td colspan="2" class="table-header">
       
   232     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   233       <tr valign="top">
       
   234         <td align="left"><span class="table-header">Method Details</span></td>
       
   235         <td align="right" valign="top"
       
   236          ><span class="options">[<a href="#section-MethodDetails"
       
   237          class="privatelink" onclick="toggle_private();"
       
   238          >hide private</a>]</span></td>
       
   239       </tr>
       
   240     </table>
       
   241   </td>
       
   242 </tr>
       
   243 </table>
       
   244 <a name="__init__"></a>
       
   245 <div>
       
   246 <table class="details" border="1" cellpadding="3"
       
   247        cellspacing="0" width="100%" bgcolor="white">
       
   248 <tr><td>
       
   249   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   250   <tr valign="top"><td>
       
   251   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   252         <span class="sig-arg">session</span>,
       
   253         <span class="sig-arg">project</span>)</span>
       
   254     <br /><em class="fname">(Constructor)</em>
       
   255   </h3>
       
   256   </td><td align="right" valign="top"
       
   257     ><span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult.__init__">source&nbsp;code</a></span>&nbsp;
       
   258     </td>
       
   259   </table>
       
   260   
       
   261   
       
   262   <dl class="fields">
       
   263     <dt>Overrides:
       
   264       <a href="ccm.Result-class.html#__init__">Result.__init__</a>
       
   265     </dt>
       
   266   </dl>
       
   267 </td></tr></table>
       
   268 </div>
       
   269 <a name="_setoutput"></a>
       
   270 <div class="private">
       
   271 <table class="details" border="1" cellpadding="3"
       
   272        cellspacing="0" width="100%" bgcolor="white">
       
   273 <tr><td>
       
   274   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   275   <tr valign="top"><td>
       
   276   <h3 class="epydoc"><span class="sig"><span class="sig-name">_setoutput</span>(<span class="sig-arg">self</span>,
       
   277         <span class="sig-arg">output</span>)</span>
       
   278   </h3>
       
   279   </td><td align="right" valign="top"
       
   280     ><span class="codelink"><a href="ccm-pysrc.html#ProjectCheckoutResult._setoutput">source&nbsp;code</a></span>&nbsp;
       
   281     </td>
       
   282   </table>
       
   283   
       
   284   Parsing the output of the checkout command.
       
   285   <dl class="fields">
       
   286     <dt>Overrides:
       
   287       <a href="ccm.Result-class.html#_setoutput">Result._setoutput</a>
       
   288     </dt>
       
   289   </dl>
       
   290 </td></tr></table>
       
   291 </div>
       
   292 <br />
       
   293 <!-- ==================== NAVIGATION BAR ==================== -->
       
   294 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   295        bgcolor="#a0c0ff" cellspacing="0">
       
   296   <tr valign="middle">
       
   297 
       
   298   <!-- Tree link -->
       
   299       <th>&nbsp;&nbsp;&nbsp;<a
       
   300         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   301 
       
   302   <!-- Index link -->
       
   303       <th>&nbsp;&nbsp;&nbsp;<a
       
   304         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   305 
       
   306   <!-- Help link -->
       
   307       <th>&nbsp;&nbsp;&nbsp;<a
       
   308         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   309 
       
   310       <th class="navbar" width="100%"></th>
       
   311   </tr>
       
   312 </table>
       
   313 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   314   <tr>
       
   315     <td align="left" class="footer">
       
   316     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   317     </td>
       
   318     <td align="right" class="footer">
       
   319       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   320     </td>
       
   321   </tr>
       
   322 </table>
       
   323 
       
   324 <script type="text/javascript">
       
   325   <!--
       
   326   // Private objects are initially displayed (because if
       
   327   // javascript is turned off then we want them to be
       
   328   // visible); but by default, we want to hide them.  So hide
       
   329   // them unless we have a cookie that says to show them.
       
   330   checkCookie()
       
   331   // -->
       
   332 </script>
       
   333   
       
   334 </body>
       
   335 </html>