<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>VTK: vtkSocketCollection Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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>
</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>
<div class="contents">
<h1>vtkSocketCollection Class Reference</h1><!-- doxytag: class="vtkSocketCollection" --><!-- doxytag: inherits="vtkCollection" --><code>#include <<a class="el" href="a03926.html">vtkSocketCollection.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkSocketCollection:</div>
<div class="dynsection">
<p><center><img src="a14550.png" border="0" usemap="#a14551" alt="Inheritance graph"></center>
<map name="a14551">
<area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="25,155,127,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="36,80,116,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="21,5,131,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkSocketCollection:</div>
<div class="dynsection">
<p><center><img src="a14552.png" border="0" usemap="#a14553" alt="Collaboration graph"></center>
<map name="a14553">
<area shape="rect" href="a00285.html" title="create and manipulate unsorted lists of objects" alt="" coords="80,310,181,336"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="91,96,171,123"><area shape="rect" href="a00286.html" title="vtkCollectionElement" alt="" coords="56,187,205,214"><area shape="rect" href="a01568.html" title="BSD socket encapsulation." alt="" coords="236,248,319,275"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="9,6,119,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="143,6,252,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a14554.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
a collection for sockets.
<p>
Apart from being <a class="el" href="a00285.html" title="create and manipulate unsorted lists of objects">vtkCollection</a> subclass for sockets, this class provides means to wait for activity on all the sockets in the collection simultaneously.
<p>Definition at line <a class="el" href="a03926.html#l00029">29</a> of file <a class="el" href="a03926.html">vtkSocketCollection.h</a>.</p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="a00285.html">vtkCollection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#1614f63b344cba91f392d7f16934ee86">Superclass</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#afe844a7ad810103adb09d2599172ce9">GetClassName</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#3d36eadc093b47975939fa8f71c0f766">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#cf00b036e9c625c76991484dd54a491f">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#64c41ef7c22bcae617e44fff7d4abb34">AddItem</a> (<a class="el" href="a01568.html">vtkSocket</a> *soc)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#e21583c20f6a1f8c9ebdb4daa92ee2da">SelectSockets</a> (unsigned long msec=0)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01568.html">vtkSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#2a630587bd6ad47e5dc126bc99e8ec24">GetLastSelectedSocket</a> ()</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#66b506127915cfdccb7b70c2e984611f">ReplaceItem</a> (int i, <a class="el" href="a01084.html">vtkObject</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#0ee18153f93ab36b2d01cf4e8f15d9f7">RemoveItem</a> (int i)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#348d92948e9edbac508518ca67556067">RemoveItem</a> (<a class="el" href="a01084.html">vtkObject</a> *)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#eb24f147554c40bd367ed8916cbb6c99">RemoveAllItems</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01569.html">vtkSocketCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#5dde3696bce39cf5d730139ac9172bb5">New</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#325972042bda99af489f30c0d33b85cc">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01569.html">vtkSocketCollection</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#22c34aadbff17e4d0502db1ec49a1045">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#ff4e20914717359a6e4057ece6ce40ca">vtkSocketCollection</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#5ab206911950421f93afb36881eaaadf">~vtkSocketCollection</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a01568.html">vtkSocket</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01569.html#2212a52a11156f15f2864cbb3cf00225">SelectedSocket</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="1614f63b344cba91f392d7f16934ee86"></a><!-- doxytag: member="vtkSocketCollection::Superclass" ref="1614f63b344cba91f392d7f16934ee86" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00285.html">vtkCollection</a> <a class="el" href="a00285.html">vtkSocketCollection::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00285.html#6f58f8e81f0bf6117532fded21d224ec">vtkCollection</a>.</p>
<p>Definition at line <a class="el" href="a03926.html#l00033">33</a> of file <a class="el" href="a03926.html">vtkSocketCollection.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="ff4e20914717359a6e4057ece6ce40ca"></a><!-- doxytag: member="vtkSocketCollection::vtkSocketCollection" ref="ff4e20914717359a6e4057ece6ce40ca" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkSocketCollection::vtkSocketCollection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5ab206911950421f93afb36881eaaadf"></a><!-- doxytag: member="vtkSocketCollection::~vtkSocketCollection" ref="5ab206911950421f93afb36881eaaadf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkSocketCollection::~vtkSocketCollection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5dde3696bce39cf5d730139ac9172bb5"></a><!-- doxytag: member="vtkSocketCollection::New" ref="5dde3696bce39cf5d730139ac9172bb5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01569.html">vtkSocketCollection</a>* vtkSocketCollection::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct with empty list.
<p>Reimplemented from <a class="el" href="a00285.html#8d47e38b592adfa195db9bf6ba1e3dc5">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="afe844a7ad810103adb09d2599172ce9"></a><!-- doxytag: member="vtkSocketCollection::GetClassName" ref="afe844a7ad810103adb09d2599172ce9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkSocketCollection::GetClassName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00285.html#172b206cb7e0c4b08dde33523d678912">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="325972042bda99af489f30c0d33b85cc"></a><!-- doxytag: member="vtkSocketCollection::IsTypeOf" ref="325972042bda99af489f30c0d33b85cc" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkSocketCollection::IsTypeOf </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a00285.html#642e1edd0682930b26264d148e5720af">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="3d36eadc093b47975939fa8f71c0f766"></a><!-- doxytag: member="vtkSocketCollection::IsA" ref="3d36eadc093b47975939fa8f71c0f766" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkSocketCollection::IsA </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
<p>Reimplemented from <a class="el" href="a00285.html#107affed7b654d49554898b4343565ba">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="22c34aadbff17e4d0502db1ec49a1045"></a><!-- doxytag: member="vtkSocketCollection::SafeDownCast" ref="22c34aadbff17e4d0502db1ec49a1045" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01569.html">vtkSocketCollection</a>* vtkSocketCollection::SafeDownCast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> <em>o</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00285.html#dee7db9bea4f5be7b87fd49f4b1fe007">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="cf00b036e9c625c76991484dd54a491f"></a><!-- doxytag: member="vtkSocketCollection::PrintSelf" ref="cf00b036e9c625c76991484dd54a491f" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocketCollection::PrintSelf </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname"> <em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00869.html">vtkIndent</a> </td>
<td class="paramname"> <em>indent</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use <a class="el" href="a01085.html#edadf6378465fd81c2592ef64262e2a5">Print()</a> instead) but used in the hierarchical print process to combine the output of several classes.
<p>Reimplemented from <a class="el" href="a00285.html#712f7aac0d04f73c7002cd15ec3d8d11">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="64c41ef7c22bcae617e44fff7d4abb34"></a><!-- doxytag: member="vtkSocketCollection::AddItem" ref="64c41ef7c22bcae617e44fff7d4abb34" args="(vtkSocket *soc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocketCollection::AddItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01568.html">vtkSocket</a> * </td>
<td class="paramname"> <em>soc</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e21583c20f6a1f8c9ebdb4daa92ee2da"></a><!-- doxytag: member="vtkSocketCollection::SelectSockets" ref="e21583c20f6a1f8c9ebdb4daa92ee2da" args="(unsigned long msec=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vtkSocketCollection::SelectSockets </td>
<td>(</td>
<td class="paramtype">unsigned long </td>
<td class="paramname"> <em>msec</em> = <code>0</code> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Select all Connected sockets in the collection. If msec is specified, it timesout after msec milliseconds on inactivity. Returns 0 on timeout, -1 on error; 1 is a socket was selected. The selected socket can be retrieved by <a class="el" href="a01569.html#2a630587bd6ad47e5dc126bc99e8ec24">GetLastSelectedSocket()</a>.
</div>
</div><p>
<a class="anchor" name="2a630587bd6ad47e5dc126bc99e8ec24"></a><!-- doxytag: member="vtkSocketCollection::GetLastSelectedSocket" ref="2a630587bd6ad47e5dc126bc99e8ec24" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01568.html">vtkSocket</a>* vtkSocketCollection::GetLastSelectedSocket </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns the socket selected during the last <a class="el" href="a01569.html#e21583c20f6a1f8c9ebdb4daa92ee2da">SelectSockets()</a>, if any. NULL otherwise.
<p>Definition at line <a class="el" href="a03926.html#l00048">48</a> of file <a class="el" href="a03926.html">vtkSocketCollection.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="66b506127915cfdccb7b70c2e984611f"></a><!-- doxytag: member="vtkSocketCollection::ReplaceItem" ref="66b506127915cfdccb7b70c2e984611f" args="(int i, vtkObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocketCollection::ReplaceItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Overridden to unset SelectedSocket.
<p>Reimplemented from <a class="el" href="a00285.html#78da07676e5dbcb0533ead5a661ef077">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="0ee18153f93ab36b2d01cf4e8f15d9f7"></a><!-- doxytag: member="vtkSocketCollection::RemoveItem" ref="0ee18153f93ab36b2d01cf4e8f15d9f7" args="(int i)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocketCollection::RemoveItem </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Overridden to unset SelectedSocket.
<p>Reimplemented from <a class="el" href="a00285.html#699c26db069686f84bc056d53f0d4c05">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="348d92948e9edbac508518ca67556067"></a><!-- doxytag: member="vtkSocketCollection::RemoveItem" ref="348d92948e9edbac508518ca67556067" args="(vtkObject *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocketCollection::RemoveItem </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Overridden to unset SelectedSocket.
<p>Reimplemented from <a class="el" href="a00285.html#97005d6630afdfdd0ccc10b5810f6059">vtkCollection</a>.</p>
</div>
</div><p>
<a class="anchor" name="eb24f147554c40bd367ed8916cbb6c99"></a><!-- doxytag: member="vtkSocketCollection::RemoveAllItems" ref="eb24f147554c40bd367ed8916cbb6c99" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkSocketCollection::RemoveAllItems </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Overridden to unset SelectedSocket.
<p>Reimplemented from <a class="el" href="a00285.html#cf3aa093c9a16040fa224234054435d5">vtkCollection</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="2212a52a11156f15f2864cbb3cf00225"></a><!-- doxytag: member="vtkSocketCollection::SelectedSocket" ref="2212a52a11156f15f2864cbb3cf00225" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01568.html">vtkSocket</a>* <a class="el" href="a01569.html#2212a52a11156f15f2864cbb3cf00225">vtkSocketCollection::SelectedSocket</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a03926.html#l00063">63</a> of file <a class="el" href="a03926.html">vtkSocketCollection.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Common/<a class="el" href="a03926.html">vtkSocketCollection.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:34:58 2009 for VTK by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
60f1dc962abad0f3b492991a4fbef9be
>
files
>
1572
