| author | Simon Howkins <simonh@symbian.org> |
| Wed, 11 Nov 2009 14:55:58 +0000 | |
| changeset 754 | 79bd241158d3 |
| parent 432 | f2ddfa555b0f |
| permissions | -rw-r--r-- |
<?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>ccm.Project</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="ccm-module.html">Package ccm</a> :: Class Project </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="ccm.Project-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class Project</h1><span class="codelink"><a href="ccm-pysrc.html#Project">source code</a></span><br /><br /> <pre class="base-tree"> object --+ | <a href="ccm.FourPartName-class.html">FourPartName</a> --+ | <a href="ccm.CCMObject-class.html">CCMObject</a> --+ | <strong class="uidshort">Project</strong> </pre> <hr /> Wrapper class for Synergy project object.<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="ccm.Project-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">session</span>, <span class="summary-sig-arg">fpn</span>)</span><br /> Create a FourPartName object based on a ifpn string.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.__init__">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="_gettasks"></a><span class="summary-sig-name">_gettasks</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project._gettasks">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 name="add_task"></a><span class="summary-sig-name">add_task</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">task</span>)</span><br /> Add a task to the update properties.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.add_task">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 name="remove_task"></a><span class="summary-sig-name">remove_task</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">task</span>)</span><br /> Remove a task to the update properties.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.remove_task">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 name="add_folder"></a><span class="summary-sig-name">add_folder</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">folder</span>)</span><br /> Add a folder to the update properties.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.add_folder">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 name="remove_folder"></a><span class="summary-sig-name">remove_folder</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">folder</span>)</span><br /> Remove a folder to the update properties.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.remove_folder">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="_getfolders"></a><span class="summary-sig-name">_getfolders</span>(<span class="summary-sig-arg">self</span>)</span><br /> Wrapper method to return the folder list from the update properties - please use the folders attribute to access it.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project._getfolders">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="_getsubprojects"></a><span class="summary-sig-name">_getsubprojects</span>(<span class="summary-sig-arg">self</span>)</span><br /> Wrapper method to return the subprojects list - please use the subprojects attribute to access it.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project._getsubprojects">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 name="get_members"></a><span class="summary-sig-name">get_members</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recursive</span>=<span class="summary-sig-default">False</span>, <span class="summary-sig-arg">**kargs</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.get_members">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 href="ccm.Project-class.html#_getrelease" class="summary-sig-name">_getrelease</a>(<span class="summary-sig-arg">self</span>)</span><br /> Get the release of the current object.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project._getrelease">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="_setrelease"></a><span class="summary-sig-name">_setrelease</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">release</span>)</span><br /> Set the release of the current object.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project._setrelease">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 name="refresh"></a><span class="summary-sig-name">refresh</span>(<span class="summary-sig-arg">self</span>)</span><br /> Refresh project update properties.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.refresh">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="_getbaseline"></a><span class="summary-sig-name">_getbaseline</span>(<span class="summary-sig-arg">self</span>)</span><br /> Get the baseline of the current project.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project._getbaseline">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="ccm.Project-class.html#set_baseline" class="summary-sig-name">set_baseline</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">baseline</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">False</span>)</span><br /> Set project baseline.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.set_baseline">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 name="set_update_method"></a><span class="summary-sig-name">set_update_method</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">name</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">False</span>)</span><br /> Set the update method for the project (and subproject if recurse is True).</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.set_update_method">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 name="apply_update_properties"></a><span class="summary-sig-name">apply_update_properties</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">baseline</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">tasks_and_folders</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">True</span>)</span><br /> Apply update properties to subprojects.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.apply_update_properties">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 name="root_dir"></a><span class="summary-sig-name">root_dir</span>(<span class="summary-sig-arg">self</span>)</span><br /> Return the directory attached to a project.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.root_dir">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 name="snapshot"></a><span class="summary-sig-name">snapshot</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">targetdir</span>, <span class="summary-sig-arg">recursive</span>=<span class="summary-sig-default">False</span>)</span><br /> Take a snapshot of the project.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.snapshot">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="ccm.Project-class.html#checkout" class="summary-sig-name">checkout</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">release</span>, <span class="summary-sig-arg">version</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">purpose</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">subprojects</span>=<span class="summary-sig-default">True</span>)</span><br /> Create a checkout of this project.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.checkout">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="ccm.Project-class.html#work_area" class="summary-sig-name">work_area</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">maintain</span>, <span class="summary-sig-arg">recursive</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">relative</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">path</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">pst</span>=<span class="summary-sig-default">None</span>, <span class="summary-sig-arg">wat</span>=<span class="summary-sig-default">False</span>)</span><br /> Configure the work area.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.work_area">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 name="update"></a><span class="summary-sig-name">update</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">replaceprojects</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">keepgoing</span>=<span class="summary-sig-default">False</span>, <span class="summary-sig-arg">result</span>=<span class="summary-sig-default">None</span>)</span><br /> Update the project based on its reconfigure properties.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.update">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 name="reconcile"></a><span class="summary-sig-name">reconcile</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">updatewa</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">consideruncontrolled</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">missingwafile</span>=<span class="summary-sig-default">True</span>, <span class="summary-sig-arg">report</span>=<span class="summary-sig-default">True</span>)</span><br /> Reconcile the project to force the work area to match the database.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.reconcile">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 name="get_latest_baseline"></a><span class="summary-sig-name">get_latest_baseline</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">filterstring</span>=<span class="summary-sig-default">"*"</span>, <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">"released"</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.get_latest_baseline">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 name="create_baseline"></a><span class="summary-sig-name">create_baseline</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">baseline_name</span>, <span class="summary-sig-arg">release</span>, <span class="summary-sig-arg">baseline_tag</span>, <span class="summary-sig-arg">purpose</span>=<span class="summary-sig-default">"System Testing"</span>, <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">"published_baseline"</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.create_baseline">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="ccm.Project-class.html#sync" class="summary-sig-name">sync</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">False</span>, <span class="summary-sig-arg">static</span>=<span class="summary-sig-default">False</span>)</span><br /> Synchronize project content.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.sync">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 name="conflicts"></a><span class="summary-sig-name">conflicts</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">recurse</span>=<span class="summary-sig-default">False</span>, <span class="summary-sig-arg">tasks</span>=<span class="summary-sig-default">False</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.conflicts">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 name="tasks"></a><span class="summary-sig-name">tasks</span>(<span class="summary-sig-arg">self</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.tasks">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 name="folders"></a><span class="summary-sig-name">folders</span>(<span class="summary-sig-arg">self</span>)</span><br /> Wrapper method to return the folder list from the update properties - please use the folders attribute to access it.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.folders">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 name="subprojects"></a><span class="summary-sig-name">subprojects</span>(<span class="summary-sig-arg">self</span>)</span><br /> Wrapper method to return the subprojects list - please use the subprojects attribute to access it.</td> <td align="right" valign="top"> <span class="codelink"><a href="ccm-pysrc.html#Project.subprojects">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="ccm.CCMObject-class.html">CCMObject</a></code></b>: <code><a href="ccm.CCMObject-class.html#__getitem__">__getitem__</a></code>, <code><a href="ccm.CCMObject-class.html#__setitem__">__setitem__</a></code>, <code><a href="ccm.CCMObject-class.html#create_attribute">create_attribute</a></code>, <code><a href="ccm.CCMObject-class.html#exists">exists</a></code>, <code><a href="ccm.CCMObject-class.html#finduse">finduse</a></code>, <code><a href="ccm.CCMObject-class.html#is_predecessor_of">is_predecessor_of</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of">is_recursive_predecessor_of</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_predecessor_of_fast">is_recursive_predecessor_of_fast</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_successor_of_fast">is_recursive_successor_of_fast</a></code>, <code><a href="ccm.CCMObject-class.html#is_recursive_sucessor_of">is_recursive_sucessor_of</a></code>, <code><a href="ccm.CCMObject-class.html#keys">keys</a></code>, <code><a href="ccm.CCMObject-class.html#predecessors">predecessors</a></code>, <code><a href="ccm.CCMObject-class.html#relate">relate</a></code>, <code><a href="ccm.CCMObject-class.html#session">session</a></code>, <code><a href="ccm.CCMObject-class.html#successors">successors</a></code> </p> <div class="private"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.CCMObject-class.html">CCMObject</a></code></b> (private): <code><a href="ccm.CCMObject-class.html#_getsession">_getsession</a></code> </p></div> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: <code><a href="ccm.FourPartName-class.html#__eq__">__eq__</a></code>, <code><a href="ccm.FourPartName-class.html#__ne__">__ne__</a></code>, <code><a href="ccm.FourPartName-class.html#__repr__">__repr__</a></code>, <code><a href="ccm.FourPartName-class.html#__str__">__str__</a></code>, <code><a href="ccm.FourPartName-class.html#family">family</a></code>, <code><a href="ccm.FourPartName-class.html#instance">instance</a></code>, <code><a href="ccm.FourPartName-class.html#is_same_family">is_same_family</a></code>, <code><a href="ccm.FourPartName-class.html#name">name</a></code>, <code><a href="ccm.FourPartName-class.html#objectname">objectname</a></code>, <code><a href="ccm.FourPartName-class.html#type">type</a></code>, <code><a href="ccm.FourPartName-class.html#version">version</a></code> </p> <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>__setattr__</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> <td colspan="2" class="summary"> <p class="indent-wrapped-lines"><b>Inherited from <code><a href="ccm.FourPartName-class.html">FourPartName</a></code></b>: <code><a href="ccm.FourPartName-class.html#convert">convert</a></code>, <code><a href="ccm.FourPartName-class.html#is_valid">is_valid</a></code> </p> </td> </tr> </table> <!-- ==================== CLASS VARIABLES ==================== --> <a name="section-ClassVariables"></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">Class Variables</span></td> <td align="right" valign="top" ><span class="options">[<a href="#section-ClassVariables" 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"> <a name="release"></a><span class="summary-name">release</span> = <code title="property(_getrelease, _setrelease)">property(_getrelease, _setrelease)</code> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <a name="baseline"></a><span class="summary-name">baseline</span> = <code title="property(_getbaseline, set_baseline)">property(_getbaseline, set_baseline)</code> </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">session</span>, <span class="sig-arg">fpn</span>)</span> <br /><em class="fname">(Constructor)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Project.__init__">source code</a></span> </td> </table> <p>Create a FourPartName object based on a ifpn string.</p> <p>The string have to match the following patterns: - name-version:type:instance - name:version:releasedef:instance - Task database#id - Folder database#id</p> <p>Anything else is considered as old release string format.</p> <dl class="fields"> <dt>Overrides: <a href="ccm.CCMObject-class.html#__init__">CCMObject.__init__</a> </dt> </dl> </td></tr></table> </div> <a name="_getrelease"></a> <div class="private"> <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">_getrelease</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Project._getrelease">source code</a></span> </td> </table> Get the release of the current object. Returns a Releasedef object. <dl class="fields"> </dl> </td></tr></table> </div> <a name="set_baseline"></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">set_baseline</span>(<span class="sig-arg">self</span>, <span class="sig-arg">baseline</span>, <span class="sig-arg">recurse</span>=<span class="sig-default">False</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Project.set_baseline">source code</a></span> </td> </table> Set project baseline. raise a CCMException in case or error. <dl class="fields"> </dl> </td></tr></table> </div> <a name="checkout"></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">checkout</span>(<span class="sig-arg">self</span>, <span class="sig-arg">release</span>, <span class="sig-arg">version</span>=<span class="sig-default">None</span>, <span class="sig-arg">purpose</span>=<span class="sig-default">None</span>, <span class="sig-arg">subprojects</span>=<span class="sig-default">True</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Project.checkout">source code</a></span> </td> </table> <p>Create a checkout of this project.</p> <p>This will only checkout the project in Synergy. It does not create a work area.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>release</code></strong> - The Synergy release tag to use.</li> <li><strong class="pname"><code>version</code></strong> - The new version to use for the project. This is applied to all subprojects.</li> <li><strong class="pname"><code>purpose</code></strong> - The purpose of the checkout. Determines automatically the role from the purpose and switch it automatically (Could be any role from the DB).</li> </ul></dd> </dl> </td></tr></table> </div> <a name="work_area"></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">work_area</span>(<span class="sig-arg">self</span>, <span class="sig-arg">maintain</span>, <span class="sig-arg">recursive</span>=<span class="sig-default">None</span>, <span class="sig-arg">relative</span>=<span class="sig-default">None</span>, <span class="sig-arg">path</span>=<span class="sig-default">None</span>, <span class="sig-arg">pst</span>=<span class="sig-default">None</span>, <span class="sig-arg">wat</span>=<span class="sig-default">False</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Project.work_area">source code</a></span> </td> </table> Configure the work area. This allow to enable it or disable it, set the path, recursion... <dl class="fields"> </dl> </td></tr></table> </div> <a name="sync"></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">sync</span>(<span class="sig-arg">self</span>, <span class="sig-arg">recurse</span>=<span class="sig-default">False</span>, <span class="sig-arg">static</span>=<span class="sig-default">False</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="ccm-pysrc.html#Project.sync">source code</a></span> </td> </table> Synchronize project content. By default it is not been done recusively. (Not unittested) <dl class="fields"> </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:17 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>