<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: CS::Threading::ThreadGroup Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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 class="nav">
<a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1Threading.html">Threading</a>::<a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html">ThreadGroup</a></div>
<h1>CS::Threading::ThreadGroup Class Reference</h1><!-- doxytag: class="CS::Threading::ThreadGroup" --><!-- doxytag: inherits="CS::Implementation::NonCopyable_" -->A group of threads handled as one unit.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="threading_2thread_8h-source.html">csutil/threading/thread.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for CS::Threading::ThreadGroup:</div>
<div class="dynsection">
<p><center><img src="classCS_1_1Threading_1_1ThreadGroup__inherit__graph.png" border="0" usemap="#CS_1_1Threading_1_1ThreadGroup__inherit__map" alt="Inheritance graph"></center>
<map name="CS_1_1Threading_1_1ThreadGroup__inherit__map">
<area shape="rect" href="classCS_1_1Implementation_1_1NonCopyable__.html" title="Base-class which ensures that derived classes are not copy-constructible or assignable..." alt="" coords="39,7,175,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classCS_1_1Threading_1_1ThreadGroup-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#ba2a15329d6f104d1d7b5c20be3ea6ef">Add</a> (<a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a> *thread)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add a thread to the group. <a href="#ba2a15329d6f104d1d7b5c20be3ea6ef"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#3613548b3e848eee2c2d64cf3184c6c6">GetSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get number of threads in group. <a href="#3613548b3e848eee2c2d64cf3184c6c6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#0979401738730891e7248d8251ebf147">GetThread</a> (size_t index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get thread with specific index. <a href="#0979401738730891e7248d8251ebf147"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#c699e578b17ae9b70cc58d614bbea469">Remove</a> (<a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a> *thread)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove thread from group. <a href="#c699e578b17ae9b70cc58d614bbea469"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#8d8e8e8037bb39e9c93b11d1b8c10004">StartAll</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start all threads in the group. <a href="#8d8e8e8037bb39e9c93b11d1b8c10004"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#934a90c25ab8e45c421f0a4a14bd0828">StopAll</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop all threads in the group. <a href="#934a90c25ab8e45c421f0a4a14bd0828"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html#c440785265a585a6fd38c3ac7b9413de">WaitAll</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for all threads in the group. <a href="#c440785265a585a6fd38c3ac7b9413de"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A group of threads handled as one unit.
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00231">231</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ba2a15329d6f104d1d7b5c20be3ea6ef"></a><!-- doxytag: member="CS::Threading::ThreadGroup::Add" ref="ba2a15329d6f104d1d7b5c20be3ea6ef" args="(Thread *thread)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CS::Threading::ThreadGroup::Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a> * </td>
<td class="paramname"> <em>thread</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a thread to the group.
<p>
A thread will only be added once, even if you run Add two times with same thread object.
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00240">240</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="3613548b3e848eee2c2d64cf3184c6c6"></a><!-- doxytag: member="CS::Threading::ThreadGroup::GetSize" ref="3613548b3e848eee2c2d64cf3184c6c6" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t CS::Threading::ThreadGroup::GetSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get number of threads in group.
<p>
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00267">267</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="0979401738730891e7248d8251ebf147"></a><!-- doxytag: member="CS::Threading::ThreadGroup::GetThread" ref="0979401738730891e7248d8251ebf147" args="(size_t index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a>* CS::Threading::ThreadGroup::GetThread </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get thread with specific index.
<p>
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00258">258</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c699e578b17ae9b70cc58d614bbea469"></a><!-- doxytag: member="CS::Threading::ThreadGroup::Remove" ref="c699e578b17ae9b70cc58d614bbea469" args="(Thread *thread)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CS::Threading::ThreadGroup::Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a> * </td>
<td class="paramname"> <em>thread</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove thread from group.
<p>
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00249">249</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8d8e8e8037bb39e9c93b11d1b8c10004"></a><!-- doxytag: member="CS::Threading::ThreadGroup::StartAll" ref="8d8e8e8037bb39e9c93b11d1b8c10004" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CS::Threading::ThreadGroup::StartAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Start all threads in the group.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCS_1_1Threading_1_1Thread.html#4f8faa0dc54ad247f46664759bc20ec8" title="Start the thread.">Thread::Start</a> </dd></dl>
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00276">276</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="934a90c25ab8e45c421f0a4a14bd0828"></a><!-- doxytag: member="CS::Threading::ThreadGroup::StopAll" ref="934a90c25ab8e45c421f0a4a14bd0828" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CS::Threading::ThreadGroup::StopAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Stop all threads in the group.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCS_1_1Threading_1_1Thread.html#55ac5876b0b8814493ec2886618ce2ba" title="Unmercifully stop the thread as soon as possible.">Thread::Stop</a> </dd></dl>
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00290">290</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="c440785265a585a6fd38c3ac7b9413de"></a><!-- doxytag: member="CS::Threading::ThreadGroup::WaitAll" ref="c440785265a585a6fd38c3ac7b9413de" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CS::Threading::ThreadGroup::WaitAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Wait for all threads in the group.
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classCS_1_1Threading_1_1Thread.html#d3188de0c90be2d4f700a76c638c78f1" title="Wait for thread to finish its execution.">Thread::Wait</a> </dd></dl>
<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00304">304</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/threading/<a class="el" href="threading_2thread_8h-source.html">thread.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
173
