<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>preparation.PreparationCheckout</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="preparation-module.html">Module preparation</a> ::
Class PreparationCheckout
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="preparation.PreparationCheckout-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PreparationCheckout</h1><span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<a href="preparation.PreparationAction-class.html">PreparationAction</a> --+
|
<strong class="uidshort">PreparationCheckout</strong>
</pre>
<hr />
Handle the checkout and update of project content.<br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="preparation.PreparationCheckout-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">config</span>,
<span class="summary-sig-arg">builder</span>)</span><br />
Initialization.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="preparation.PreparationCheckout-class.html#check" class="summary-sig-name">check</a>(<span class="summary-sig-arg">self</span>)</span><br />
Checks if all synergy resources are available.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.check">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="preparation.PreparationCheckout-class.html#execute" class="summary-sig-name">execute</a>(<span class="summary-sig-arg">self</span>)</span><br />
Creates a checkout of the project, or updates an existing checkout if one is found.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.execute">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">project</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__find_project">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__setup_project"></a><span class="summary-sig-name">__setup_project</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">project</span>,
<span class="summary-sig-arg">coproject</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__setup_project">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_sync"></a><span class="summary-sig-name">_sync</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">coproject</span>)</span><br />
Run the sync if the 'sync' property is defined to true in the
configuration</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout._sync">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__set_release"></a><span class="summary-sig-name">__set_release</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">project</span>)</span><br />
Update the release of the project hierarchy if required.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__set_release">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__fix_baseline"></a><span class="summary-sig-name">__fix_baseline</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">coproject</span>)</span><br />
Check for project in a different status, then check them out.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__fix_baseline">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_check_conflicts"></a><span class="summary-sig-name">_check_conflicts</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">coproject</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout._check_conflicts">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__set_subbaselines"></a><span class="summary-sig-name">__set_subbaselines</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">project</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__set_subbaselines">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__get_array"></a><span class="summary-sig-name">__get_array</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">key</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__get_array">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__get_subbaselines"></a><span class="summary-sig-name">__get_subbaselines</span>(<span class="summary-sig-arg">self</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__get_subbaselines">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__get_tasks"></a><span class="summary-sig-name">__get_tasks</span>(<span class="summary-sig-arg">self</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__get_tasks">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__get_folders"></a><span class="summary-sig-name">__get_folders</span>(<span class="summary-sig-arg">self</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__get_folders">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_set_tasks_and_folders"></a><span class="summary-sig-name">_set_tasks_and_folders</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">project</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout._set_tasks_and_folders">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="preparation.PreparationAction-class.html">PreparationAction</a></code></b>:
<code><a href="preparation.PreparationAction-class.html#get_session">get_session</a></code>,
<code><a href="preparation.PreparationAction-class.html#get_threads">get_threads</a></code>
</p>
<div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="preparation.PreparationAction-class.html">PreparationAction</a></code></b> (private):
<code><a href="preparation.PreparationAction-class.html#_check_object">_check_object</a></code>
</p></div>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== STATIC METHODS ==================== -->
<a name="section-StaticMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Static Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-StaticMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="_clean_update_properties"></a><span class="summary-sig-name">_clean_update_properties</span>(<span class="summary-sig-arg">project</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout._clean_update_properties">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__find_subproject"></a><span class="summary-sig-name">__find_subproject</span>(<span class="summary-sig-arg">subprojects</span>,
<span class="summary-sig-arg">project</span>)</span><br />
Private method.</td>
<td align="right" valign="top">
<span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__find_subproject">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">config</span>,
<span class="sig-arg">builder</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.__init__">source code</a></span>
</td>
</table>
Initialization.
<dl class="fields">
<dt>Overrides:
<a href="preparation.PreparationAction-class.html#__init__">PreparationAction.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="check"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">check</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.check">source code</a></span>
</td>
</table>
Checks if all synergy resources are available.
<dl class="fields">
<dt>Overrides:
<a href="preparation.PreparationAction-class.html#check">PreparationAction.check</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="execute"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">execute</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="preparation-pysrc.html#PreparationCheckout.execute">source code</a></span>
</td>
</table>
<p>Creates a checkout of the project, or updates an existing checkout if one is found.</p>
<p>The work area is maintained as part of this.</p>
<dl class="fields">
<dt>Overrides:
<a href="preparation.PreparationAction-class.html#execute">PreparationAction.execute</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>