<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Vidalia: CircuitItem Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>CircuitItem Class Reference</h1><!-- doxytag: class="CircuitItem" -->
<p><code>#include <<a class="el" href="_circuit_item_8h_source.html">CircuitItem.h</a>></code></p>
<p><a href="class_circuit_item-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#a6030b283a8a4ec4c6dc9388c5598a8f0">CircuitItem</a> (const <a class="el" href="class_circuit.html">Circuit</a> &circuit)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#a46b3b74322a64d61dae58deebbd6bc6e">addStream</a> (<a class="el" href="class_stream_item.html">StreamItem</a> *stream)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#a64fe0d46e4d29d6fe762ef8c82e43fb1">removeStream</a> (<a class="el" href="class_stream_item.html">StreamItem</a> *stream)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#af463413258ba86785057a694af28e55c">update</a> (const <a class="el" href="class_circuit.html">Circuit</a> &circuit)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#a00ab1f5cc2836fae97f6d8299306c069">id</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_circuit.html">Circuit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#a2967068cdbc30a1f5a3ab57843d48738">circuit</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QList< <a class="el" href="class_stream_item.html">StreamItem</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#af18957010aa7b7b467a73070cefc25f6">streams</a> () const </td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_circuit.html">Circuit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_circuit_item.html#a3c9c80435ad018feecc87ef6ea4d0a46">_circuit</a></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="_circuit_item_8h_source.html#l00029">29</a> of file <a class="el" href="_circuit_item_8h_source.html">CircuitItem.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a6030b283a8a4ec4c6dc9388c5598a8f0"></a><!-- doxytag: member="CircuitItem::CircuitItem" ref="a6030b283a8a4ec4c6dc9388c5598a8f0" args="(const Circuit &circuit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CircuitItem::CircuitItem </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_circuit.html">Circuit</a> & </td>
<td class="paramname"> <em>circuit</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor</p>
<p>Constructor </p>
<p>Definition at line <a class="el" href="_circuit_item_8cpp_source.html#l00022">22</a> of file <a class="el" href="_circuit_item_8cpp_source.html">CircuitItem.cpp</a>.</p>
<p>References <a class="el" href="_circuit_item_8cpp_source.html#l00030">update()</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a46b3b74322a64d61dae58deebbd6bc6e"></a><!-- doxytag: member="CircuitItem::addStream" ref="a46b3b74322a64d61dae58deebbd6bc6e" args="(StreamItem *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CircuitItem::addStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_stream_item.html">StreamItem</a> * </td>
<td class="paramname"> <em>stream</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a stream to this circuit item</p>
<p>Adds a stream as a child of this circuit. </p>
<p>Definition at line <a class="el" href="_circuit_item_8cpp_source.html#l00050">50</a> of file <a class="el" href="_circuit_item_8cpp_source.html">CircuitItem.cpp</a>.</p>
<p>Referenced by <a class="el" href="_circuit_list_widget_8cpp_source.html#l00171">CircuitListWidget::addStream()</a>.</p>
</div>
</div>
<a class="anchor" id="a2967068cdbc30a1f5a3ab57843d48738"></a><!-- doxytag: member="CircuitItem::circuit" ref="a2967068cdbc30a1f5a3ab57843d48738" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_circuit.html">Circuit</a> CircuitItem::circuit </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="class_circuit.html">Circuit</a> object for this item. </p>
<p>Definition at line <a class="el" href="_circuit_item_8h_source.html#l00046">46</a> of file <a class="el" href="_circuit_item_8h_source.html">CircuitItem.h</a>.</p>
<p>References <a class="el" href="_circuit_item_8h_source.html#l00051">_circuit</a>.</p>
<p>Referenced by <a class="el" href="_circuit_list_widget_8cpp_source.html#l00352">CircuitListWidget::circuits()</a>, <a class="el" href="_circuit_list_widget_8cpp_source.html#l00071">CircuitListWidget::customContextMenuRequested()</a>, <a class="el" href="_circuit_list_widget_8cpp_source.html#l00328">CircuitListWidget::onSelectionChanged()</a>, <a class="el" href="_circuit_list_widget_8cpp_source.html#l00219">CircuitListWidget::removeCircuit()</a>, and <a class="el" href="_circuit_list_widget_8cpp_source.html#l00054">CircuitListWidget::retranslateUi()</a>.</p>
</div>
</div>
<a class="anchor" id="a00ab1f5cc2836fae97f6d8299306c069"></a><!-- doxytag: member="CircuitItem::id" ref="a00ab1f5cc2836fae97f6d8299306c069" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="_circuit_8h.html#a8b7b0182a6d1ff0aab7ab31df9c3f83d">CircuitId</a> CircuitItem::id </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the ID for this circuit. </p>
<p>Definition at line <a class="el" href="_circuit_item_8h_source.html#l00044">44</a> of file <a class="el" href="_circuit_item_8h_source.html">CircuitItem.h</a>.</p>
<p>References <a class="el" href="_circuit_item_8h_source.html#l00051">_circuit</a>, and <a class="el" href="_circuit_8h_source.html#l00052">Circuit::id()</a>.</p>
<p>Referenced by <a class="el" href="_circuit_list_widget_8cpp_source.html#l00126">CircuitListWidget::closeSelectedConnections()</a>, <a class="el" href="_circuit_list_widget_8cpp_source.html#l00071">CircuitListWidget::customContextMenuRequested()</a>, and <a class="el" href="_circuit_list_widget_8cpp_source.html#l00292">CircuitListWidget::findCircuitItem()</a>.</p>
</div>
</div>
<a class="anchor" id="a64fe0d46e4d29d6fe762ef8c82e43fb1"></a><!-- doxytag: member="CircuitItem::removeStream" ref="a64fe0d46e4d29d6fe762ef8c82e43fb1" args="(StreamItem *stream)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CircuitItem::removeStream </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_stream_item.html">StreamItem</a> * </td>
<td class="paramname"> <em>stream</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes the stream item from the list and frees its memory.</p>
<p>Removes the stream item from this circuit and frees its memory </p>
<p>Definition at line <a class="el" href="_circuit_item_8cpp_source.html#l00057">57</a> of file <a class="el" href="_circuit_item_8cpp_source.html">CircuitItem.cpp</a>.</p>
<p>Referenced by <a class="el" href="_circuit_list_widget_8cpp_source.html#l00231">CircuitListWidget::removeCircuit()</a>, and <a class="el" href="_circuit_list_widget_8cpp_source.html#l00265">CircuitListWidget::removeStream()</a>.</p>
</div>
</div>
<a class="anchor" id="af18957010aa7b7b467a73070cefc25f6"></a><!-- doxytag: member="CircuitItem::streams" ref="af18957010aa7b7b467a73070cefc25f6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QList< <a class="el" href="class_stream_item.html">StreamItem</a> * > CircuitItem::streams </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a list of all stream items on this circuit. </p>
<p>Definition at line <a class="el" href="_circuit_item_8cpp_source.html#l00067">67</a> of file <a class="el" href="_circuit_item_8cpp_source.html">CircuitItem.cpp</a>.</p>
<p>References <a class="el" href="html_8cpp_source.html#l00033">i()</a>.</p>
<p>Referenced by <a class="el" href="_circuit_list_widget_8cpp_source.html#l00231">CircuitListWidget::removeCircuit()</a>, and <a class="el" href="_circuit_list_widget_8cpp_source.html#l00054">CircuitListWidget::retranslateUi()</a>.</p>
</div>
</div>
<a class="anchor" id="af463413258ba86785057a694af28e55c"></a><!-- doxytag: member="CircuitItem::update" ref="af463413258ba86785057a694af28e55c" args="(const Circuit &circuit)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CircuitItem::update </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="class_circuit.html">Circuit</a> & </td>
<td class="paramname"> <em>circuit</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Updates the status of this circuit item using the given circuit.</p>
<p>Updates the status and path of this circuit item. </p>
<p>Definition at line <a class="el" href="_circuit_item_8cpp_source.html#l00030">30</a> of file <a class="el" href="_circuit_item_8cpp_source.html">CircuitItem.cpp</a>.</p>
<p>References <a class="el" href="_circuit_item_8h_source.html#l00051">_circuit</a>, <a class="el" href="_circuit_list_widget_8h_source.html#l00037">CircuitListWidget::ConnectionColumn</a>, <a class="el" href="_circuit_8h_source.html#l00058">Circuit::length()</a>, <a class="el" href="_circuit_8h_source.html#l00060">Circuit::routerNames()</a>, <a class="el" href="_circuit_list_widget_8h_source.html#l00038">CircuitListWidget::StatusColumn</a>, and <a class="el" href="_circuit_8cpp_source.html#l00108">Circuit::statusString()</a>.</p>
<p>Referenced by <a class="el" href="_circuit_list_widget_8cpp_source.html#l00145">CircuitListWidget::addCircuit()</a>, <a class="el" href="_circuit_item_8cpp_source.html#l00022">CircuitItem()</a>, and <a class="el" href="_circuit_list_widget_8cpp_source.html#l00054">CircuitListWidget::retranslateUi()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a3c9c80435ad018feecc87ef6ea4d0a46"></a><!-- doxytag: member="CircuitItem::_circuit" ref="a3c9c80435ad018feecc87ef6ea4d0a46" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_circuit.html">Circuit</a> <a class="el" href="class_circuit_item.html#a3c9c80435ad018feecc87ef6ea4d0a46">CircuitItem::_circuit</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_circuit.html">Circuit</a> associated with this item. </p>
<p>Definition at line <a class="el" href="_circuit_item_8h_source.html#l00051">51</a> of file <a class="el" href="_circuit_item_8h_source.html">CircuitItem.h</a>.</p>
<p>Referenced by <a class="el" href="_circuit_item_8h_source.html#l00046">circuit()</a>, <a class="el" href="_circuit_item_8h_source.html#l00044">id()</a>, and <a class="el" href="_circuit_item_8cpp_source.html#l00030">update()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_circuit_item_8h_source.html">CircuitItem.h</a></li>
<li><a class="el" href="_circuit_item_8cpp_source.html">CircuitItem.cpp</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:56 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
