<?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>flumotion.common.dag.DAG</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">
Package flumotion ::
<a href="flumotion.common-module.html">Package common</a> ::
<a href="flumotion.common.dag-module.html">Module dag</a> ::
Class DAG
</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>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class DAG</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG">source code</a></span></p>
<pre class="base-tree">
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+
|
<strong class="uidshort">DAG</strong>
</pre>
<hr />
<p>I represent a Directed Acyclic Graph.</p>
<p>You can add objects to me as Nodes and then express dependency by
adding edges.</p>
<!-- ==================== 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 name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.__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="_assertExists"></a><span class="summary-sig-name">_assertExists</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">type</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG._assertExists">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="flumotion.common.dag.DAG-class.html#addNode" class="summary-sig-name">addNode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">type</span>=<span class="summary-sig-default">0</span>)</span><br />
I add a node to the DAG.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.addNode">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">Boolean</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#hasNode" class="summary-sig-name">hasNode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">type</span>=<span class="summary-sig-default">0</span>)</span><br />
I check if a node exists in the DAG.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.hasNode">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="flumotion.common.dag.DAG-class.html#removeNode" class="summary-sig-name">removeNode</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">type</span>=<span class="summary-sig-default">0</span>)</span><br />
I remove a node that exists in the DAG.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.removeNode">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="_getNode"></a><span class="summary-sig-name">_getNode</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">type</span>=<span class="summary-sig-default">0</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG._getNode">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="flumotion.common.dag.DAG-class.html#addEdge" class="summary-sig-name">addEdge</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">child</span>,
<span class="summary-sig-arg">parenttype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">childtype</span>=<span class="summary-sig-default">0</span>)</span><br />
I add an edge between two nodes in the DAG.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.addEdge">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="flumotion.common.dag.DAG-class.html#removeEdge" class="summary-sig-name">removeEdge</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">parent</span>,
<span class="summary-sig-arg">child</span>,
<span class="summary-sig-arg">parenttype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">childtype</span>=<span class="summary-sig-default">0</span>)</span><br />
I remove an edge between two nodes in the DAG.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.removeEdge">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of (object, object)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getChildrenTyped" class="summary-sig-name">getChildrenTyped</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">types</span>=<span class="summary-sig-default">None</span>)</span><br />
I return a list of (object, type) tuples that are direct children of
this object,objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getChildrenTyped">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of objects</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getChildren" class="summary-sig-name">getChildren</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">types</span>=<span class="summary-sig-default">None</span>)</span><br />
I return a list of objects that are direct children of this
object,objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getChildren">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of (object, object)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getParentsTyped" class="summary-sig-name">getParentsTyped</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">types</span>=<span class="summary-sig-default">None</span>)</span><br />
I return a list of (object, type) tuples that are direct parents of
this object, objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getParentsTyped">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of (object, object)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getParents" class="summary-sig-name">getParents</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">types</span>=<span class="summary-sig-default">None</span>)</span><br />
I return a list of objects that are direct parents of this object,
objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getParents">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of (object,Integer)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getOffspringTyped" class="summary-sig-name">getOffspringTyped</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">*types</span>)</span><br />
I return a list of (object, type) tuples that are offspring of this
object,objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getOffspringTyped">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of objects</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getOffspring" class="summary-sig-name">getOffspring</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">*types</span>)</span><br />
I return a list of objects that are offspring of this object,objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getOffspring">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of (object,Integer)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getAncestorsTyped" class="summary-sig-name">getAncestorsTyped</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">*types</span>)</span><br />
I return a list of (object, type) tuples that are ancestors of this
object,objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getAncestorsTyped">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of objects</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#getAncestors" class="summary-sig-name">getAncestors</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>,
<span class="summary-sig-arg">*types</span>)</span><br />
I return a list of objects that are ancestors of this object,objtype.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getAncestors">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">Boolean</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#isFloating" class="summary-sig-name">isFloating</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">object</span>,
<span class="summary-sig-arg">objtype</span>=<span class="summary-sig-default">0</span>)</span><br />
I return whether the object is floating: no parents and no children.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.isFloating">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="flumotion.common.dag.DAG-class.html#hasCycle" class="summary-sig-name">hasCycle</a>(<span class="summary-sig-arg">self</span>)</span><br />
I return whether or not the graph has a cycle.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.hasCycle">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of (object, type)</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="sort"></a><span class="summary-sig-name">sort</span>(<span class="summary-sig-arg">self</span>)</span><br />
I return a topologically sorted list of objects.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.sort">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">list of {Node}</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.common.dag.DAG-class.html#_sortPreferred" class="summary-sig-name" onclick="show_private();">_sortPreferred</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">list</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">clearState</span>=<span class="summary-sig-default">True</span>)</span><br />
I return a topologically sorted list of nodes, using list as a
preferred order for the algorithm.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG._sortPreferred">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="_dfs"></a><span class="summary-sig-name">_dfs</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">node</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG._dfs">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">list of object</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="getAllNodesByType"></a><span class="summary-sig-name">getAllNodesByType</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">type</span>)</span><br />
I return all the objects with node type specified by type</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getAllNodesByType">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="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#debug">debug</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</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 colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#logCategory">logCategory</a></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="addNode"></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">addNode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">type</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.addNode">source code</a></span>
</td>
</tr></table>
<p>I add a node to the DAG.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to put in the DAG</li>
<li><strong class="pname"><code>type</code></strong> - optional type for the object</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="hasNode"></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">hasNode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">type</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.hasNode">source code</a></span>
</td>
</tr></table>
<p>I check if a node exists in the DAG.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - The object to check existence of.</li>
<li><strong class="pname"><code>type</code></strong> (Integer) - An optional type for the object to check.</li>
</ul></dd>
<dt>Returns: Boolean</dt>
</dl>
</td></tr></table>
</div>
<a name="removeNode"></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">removeNode</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">type</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.removeNode">source code</a></span>
</td>
</tr></table>
<p>I remove a node that exists in the DAG. I also remove any edges
pointing to this node.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - The object to remove.</li>
<li><strong class="pname"><code>type</code></strong> - The type of object to remove (optional).</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="addEdge"></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">addEdge</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">parent</span>,
<span class="sig-arg">child</span>,
<span class="sig-arg">parenttype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">childtype</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.addEdge">source code</a></span>
</td>
</tr></table>
<p>I add an edge between two nodes in the DAG.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - The object that is to be the parent.</li>
<li><strong class="pname"><code>child</code></strong> - The object that is to be the child.</li>
<li><strong class="pname"><code>parenttype</code></strong> - The type of the parent object (optional).</li>
<li><strong class="pname"><code>childtype</code></strong> - The type of the child object (optional).</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="removeEdge"></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">removeEdge</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">parent</span>,
<span class="sig-arg">child</span>,
<span class="sig-arg">parenttype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">childtype</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.removeEdge">source code</a></span>
</td>
</tr></table>
<p>I remove an edge between two nodes in the DAG.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>parent</code></strong> - The object that is the parent,</li>
<li><strong class="pname"><code>child</code></strong> - The object that is the child.</li>
<li><strong class="pname"><code>parenttype</code></strong> - The type of the parent object (optional).</li>
<li><strong class="pname"><code>childtype</code></strong> - The type of the child object (optional).</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="getChildrenTyped"></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">getChildrenTyped</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">types</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getChildrenTyped">source code</a></span>
</td>
</tr></table>
<p>I return a list of (object, type) tuples that are direct children of
this object,objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return children of</li>
<li><strong class="pname"><code>objtype</code></strong> - type of object (optional)</li>
<li><strong class="pname"><code>types</code></strong> (list) - a list of types of children that you want. None means all.</li>
</ul></dd>
<dt>Returns: list of (object, object)</dt>
</dl>
</td></tr></table>
</div>
<a name="getChildren"></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">getChildren</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">types</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getChildren">source code</a></span>
</td>
</tr></table>
<p>I return a list of objects that are direct children of this
object,objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return children of.</li>
<li><strong class="pname"><code>objtype</code></strong> (Integer) - type of object (optional).</li>
<li><strong class="pname"><code>types</code></strong> (list of Integers) - a list of types of children that you want. None means all.</li>
</ul></dd>
<dt>Returns: list of objects</dt>
</dl>
</td></tr></table>
</div>
<a name="getParentsTyped"></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">getParentsTyped</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">types</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getParentsTyped">source code</a></span>
</td>
</tr></table>
<p>I return a list of (object, type) tuples that are direct parents of
this object, objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return parents of</li>
<li><strong class="pname"><code>objtype</code></strong> - type of object (optional)</li>
<li><strong class="pname"><code>types</code></strong> (list or None) - A list of types of parents that you want. None means all.</li>
</ul></dd>
<dt>Returns: list of (object, object)</dt>
</dl>
</td></tr></table>
</div>
<a name="getParents"></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">getParents</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">types</span>=<span class="sig-default">None</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getParents">source code</a></span>
</td>
</tr></table>
<p>I return a list of objects that are direct parents of this object,
objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return parents of.</li>
<li><strong class="pname"><code>objtype</code></strong> - type of object (optional)</li>
<li><strong class="pname"><code>types</code></strong> (list) - List of types of parents that you want. None means all.</li>
</ul></dd>
<dt>Returns: list of (object, object)</dt>
</dl>
</td></tr></table>
</div>
<a name="getOffspringTyped"></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">getOffspringTyped</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">*types</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getOffspringTyped">source code</a></span>
</td>
</tr></table>
<p>I return a list of (object, type) tuples that are offspring of this
object,objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return children of.</li>
<li><strong class="pname"><code>objtype</code></strong> (Integer) - type of object (optional).</li>
<li><strong class="pname"><code>types</code></strong> (list of Integers) - a list of types of children that you want. None means all.</li>
</ul></dd>
<dt>Returns: list of (object,Integer)</dt>
</dl>
</td></tr></table>
</div>
<a name="getOffspring"></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">getOffspring</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">*types</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getOffspring">source code</a></span>
</td>
</tr></table>
<p>I return a list of objects that are offspring of this
object,objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return children of.</li>
<li><strong class="pname"><code>objtype</code></strong> (Integer) - type of object (optional).</li>
<li><strong class="pname"><code>types</code></strong> - types of children that you want offspring returned of.</li>
</ul></dd>
<dt>Returns: list of objects</dt>
</dl>
</td></tr></table>
</div>
<a name="getAncestorsTyped"></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">getAncestorsTyped</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">*types</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getAncestorsTyped">source code</a></span>
</td>
</tr></table>
<p>I return a list of (object, type) tuples that are ancestors of this
object,objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return ancestors of.</li>
<li><strong class="pname"><code>objtype</code></strong> (Integer) - type of object (optional).</li>
<li><strong class="pname"><code>types</code></strong> - types of ancestors that you want ancestors of.</li>
</ul></dd>
<dt>Returns: list of (object,Integer)</dt>
</dl>
</td></tr></table>
</div>
<a name="getAncestors"></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">getAncestors</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>,
<span class="sig-arg">*types</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.getAncestors">source code</a></span>
</td>
</tr></table>
<p>I return a list of objects that are ancestors of this
object,objtype.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to return ancestors of.</li>
<li><strong class="pname"><code>objtype</code></strong> (Integer) - type of object (optional).</li>
<li><strong class="pname"><code>types</code></strong> - types of ancestors that you want returned.</li>
</ul></dd>
<dt>Returns: list of objects</dt>
</dl>
</td></tr></table>
</div>
<a name="isFloating"></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">isFloating</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">object</span>,
<span class="sig-arg">objtype</span>=<span class="sig-default">0</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.isFloating">source code</a></span>
</td>
</tr></table>
<p>I return whether the object is floating: no parents and no
children.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>object</code></strong> - object to check if floating.</li>
<li><strong class="pname"><code>objtype</code></strong> (Integer) - type of object (optional).</li>
</ul></dd>
<dt>Returns: Boolean</dt>
</dl>
</td></tr></table>
</div>
<a name="hasCycle"></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">hasCycle</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG.hasCycle">source code</a></span>
</td>
</tr></table>
<p>I return whether or not the graph has a cycle.</p>
<p>If it has, some operations on it will fail and raise CycleError.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="_sortPreferred"></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">_sortPreferred</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">list</span>=<span class="sig-default">None</span>,
<span class="sig-arg">clearState</span>=<span class="sig-default">True</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.common.dag-pysrc.html#DAG._sortPreferred">source code</a></span>
</td>
</tr></table>
<p>I return a topologically sorted list of nodes, using list as a
preferred order for the algorithm.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>list</code></strong> (list of (object, type)) - a list of (object, type) tuples in preference order</li>
</ul></dd>
<dt>Returns: list of {Node}</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.0.1 on Sun Sep 13 13:14:02 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" 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>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
233
