<!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: vtkSubCommunicator 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>vtkSubCommunicator Class Reference</h1><!-- doxytag: class="vtkSubCommunicator" --><!-- doxytag: inherits="vtkCommunicator" --><code>#include <<a class="el" href="a05135.html">vtkSubCommunicator.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkSubCommunicator:</div>
<div class="dynsection">
<p><center><img src="a14908.png" border="0" usemap="#a14909" alt="Inheritance graph"></center>
<map name="a14909">
<area shape="rect" href="a00293.html" title="Used to send/receive messages in a multiprocess environment." alt="" coords="18,155,146,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="42,80,122,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="27,5,136,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkSubCommunicator:</div>
<div class="dynsection">
<p><center><img src="a14910.png" border="0" usemap="#a14911" alt="Collaboration graph"></center>
<map name="a14911">
<area shape="rect" href="a00293.html" title="Used to send/receive messages in a multiprocess environment." alt="" coords="25,174,153,200"><area shape="rect" href="a01304.html" title="A subgroup of processes from a communicator." alt="" coords="83,264,211,291"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="131,96,211,123"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="49,6,159,32"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="183,6,292,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="a14912.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Provides communication on a process group.
<p>
This class provides an implementation for communicating on process groups. In general, you should never use this class directly. Instead, use the <a class="el" href="a01062.html#61aa6ba18ab6e3f6339b92f5c0966876">vtkMultiProcessController::CreateSubController</a> method.<p>
<dl compact><dt><b><a class="el" href="bug.html#_bug000005">Bug:</a></b></dt><dd>Because all communication is delegated to the original communicator, any error will report process ids with respect to the original communicator, not this communicator that was actually used.</dd></dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00293.html" title="Used to send/receive messages in a multiprocess environment.">vtkCommunicator</a>, <a class="el" href="a01062.html" title="Multiprocessing communication superclass.">vtkMultiProcessController</a></dd></dl>
<dl class="user" compact><dt><b>Thanks:</b></dt><dd>This class was originally written by Kenneth Moreland (<a href="mailto:kmorel@sandia.gov">kmorel@sandia.gov</a>) from Sandia National Laboratories. </dd></dl>
<p>Definition at line <a class="el" href="a05135.html#l00052">52</a> of file <a class="el" href="a05135.html">vtkSubCommunicator.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="a00293.html">vtkCommunicator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#ba0116d953c39c6f4184d47af7416a6e">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="a01645.html#0a898303b251745983630b79fa9fdbe7">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="a01645.html#5a774992ac4f16376439dd776bb291eb">IsA</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#b60f5ef4eb2fd96bd8a8b451bf9a253a">PrintSelf</a> (ostream &os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a01304.html">vtkProcessGroup</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#529a0a66395e827dbd3ca72b92e21d43">GetGroup</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#3f4b46deb944363ff6fdf81d5da34d7e">SetGroup</a> (<a class="el" href="a01304.html">vtkProcessGroup</a> *group)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#234f54f9caf3053ce632adb46fa7f84c">SendVoidArray</a> (const void *data, <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> length, int type, int remoteHandle, int tag)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#6ef09940efe38a5594f862e73c7f08e9">ReceiveVoidArray</a> (void *data, <a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> length, int type, int remoteHandle, int tag)</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 int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#a795a3ff2cec78b7495e03e82aface7b">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01645.html">vtkSubCommunicator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#dbc64c3d73ddda2472351818b3c6c7d1">SafeDownCast</a> (<a class="el" href="a01084.html">vtkObject</a> *o)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01645.html">vtkSubCommunicator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#96b2a1733c17e788aec718437f6e30b8">New</a> ()</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="a01645.html#5f893a7e2385d64ef143fad91dc8eb9c">vtkSubCommunicator</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#af1391d1a55e68c220a5ae6867846c56">~vtkSubCommunicator</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="a01304.html">vtkProcessGroup</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01645.html#4ee41f4858bd9116056b2796cc2b4752">Group</a></td></tr>
</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="ba0116d953c39c6f4184d47af7416a6e"></a><!-- doxytag: member="vtkSubCommunicator::Superclass" ref="ba0116d953c39c6f4184d47af7416a6e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="a00293.html">vtkCommunicator</a> <a class="el" href="a00293.html">vtkSubCommunicator::Superclass</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Reimplemented from <a class="el" href="a00293.html#780e4732c5ee9c52ef8db7081b0dc3cb">vtkCommunicator</a>.</p>
<p>Definition at line <a class="el" href="a05135.html#l00055">55</a> of file <a class="el" href="a05135.html">vtkSubCommunicator.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="5f893a7e2385d64ef143fad91dc8eb9c"></a><!-- doxytag: member="vtkSubCommunicator::vtkSubCommunicator" ref="5f893a7e2385d64ef143fad91dc8eb9c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkSubCommunicator::vtkSubCommunicator </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="af1391d1a55e68c220a5ae6867846c56"></a><!-- doxytag: member="vtkSubCommunicator::~vtkSubCommunicator" ref="af1391d1a55e68c220a5ae6867846c56" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual vtkSubCommunicator::~vtkSubCommunicator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0a898303b251745983630b79fa9fdbe7"></a><!-- doxytag: member="vtkSubCommunicator::GetClassName" ref="0a898303b251745983630b79fa9fdbe7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkSubCommunicator::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="a00293.html#92d08c1a24abe616e8c79eaf634aac5e">vtkCommunicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="a795a3ff2cec78b7495e03e82aface7b"></a><!-- doxytag: member="vtkSubCommunicator::IsTypeOf" ref="a795a3ff2cec78b7495e03e82aface7b" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkSubCommunicator::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="a00293.html#475ce8d71fd296f14b8e43935c880306">vtkCommunicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="5a774992ac4f16376439dd776bb291eb"></a><!-- doxytag: member="vtkSubCommunicator::IsA" ref="5a774992ac4f16376439dd776bb291eb" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkSubCommunicator::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="a00293.html#b90429fbae3c2b8825f2987fb94f99be">vtkCommunicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="dbc64c3d73ddda2472351818b3c6c7d1"></a><!-- doxytag: member="vtkSubCommunicator::SafeDownCast" ref="dbc64c3d73ddda2472351818b3c6c7d1" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01645.html">vtkSubCommunicator</a>* vtkSubCommunicator::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="a00293.html#cb0614eb073180f1877fb8c491055684">vtkCommunicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="96b2a1733c17e788aec718437f6e30b8"></a><!-- doxytag: member="vtkSubCommunicator::New" ref="96b2a1733c17e788aec718437f6e30b8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01645.html">vtkSubCommunicator</a>* vtkSubCommunicator::New </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
<p>Reimplemented from <a class="el" href="a01084.html#4d5b227267c076d6f9e38483370b6612">vtkObject</a>.</p>
</div>
</div><p>
<a class="anchor" name="b60f5ef4eb2fd96bd8a8b451bf9a253a"></a><!-- doxytag: member="vtkSubCommunicator::PrintSelf" ref="b60f5ef4eb2fd96bd8a8b451bf9a253a" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkSubCommunicator::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="a00293.html#4de89ecef880090549ffeaf648228c29">vtkCommunicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="529a0a66395e827dbd3ca72b92e21d43"></a><!-- doxytag: member="vtkSubCommunicator::GetGroup" ref="529a0a66395e827dbd3ca72b92e21d43" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a01304.html">vtkProcessGroup</a>* vtkSubCommunicator::GetGroup </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/get the group on which communication will happen.
</div>
</div><p>
<a class="anchor" name="3f4b46deb944363ff6fdf81d5da34d7e"></a><!-- doxytag: member="vtkSubCommunicator::SetGroup" ref="3f4b46deb944363ff6fdf81d5da34d7e" args="(vtkProcessGroup *group)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkSubCommunicator::SetGroup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01304.html">vtkProcessGroup</a> * </td>
<td class="paramname"> <em>group</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set/get the group on which communication will happen.
</div>
</div><p>
<a class="anchor" name="234f54f9caf3053ce632adb46fa7f84c"></a><!-- doxytag: member="vtkSubCommunicator::SendVoidArray" ref="234f54f9caf3053ce632adb46fa7f84c" args="(const void *data, vtkIdType length, int type, int remoteHandle, int tag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkSubCommunicator::SendVoidArray </td>
<td>(</td>
<td class="paramtype">const void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>remoteHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tag</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>
Implementation for abstract supercalss.
<p>Implements <a class="el" href="a00293.html#32d70db86b6f94b8401e7aabd8da59a8">vtkCommunicator</a>.</p>
</div>
</div><p>
<a class="anchor" name="6ef09940efe38a5594f862e73c7f08e9"></a><!-- doxytag: member="vtkSubCommunicator::ReceiveVoidArray" ref="6ef09940efe38a5594f862e73c7f08e9" args="(void *data, vtkIdType length, int type, int remoteHandle, int tag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkSubCommunicator::ReceiveVoidArray </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>remoteHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>tag</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>
Implementation for abstract supercalss.
<p>Implements <a class="el" href="a00293.html#7279585811b12a45910dd2e446aa3f21">vtkCommunicator</a>.</p>
</div>
</div><p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="4ee41f4858bd9116056b2796cc2b4752"></a><!-- doxytag: member="vtkSubCommunicator::Group" ref="4ee41f4858bd9116056b2796cc2b4752" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a01304.html">vtkProcessGroup</a>* <a class="el" href="a01645.html#4ee41f4858bd9116056b2796cc2b4752">vtkSubCommunicator::Group</a><code> [protected]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>Definition at line <a class="el" href="a05135.html#l00077">77</a> of file <a class="el" href="a05135.html">vtkSubCommunicator.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>dox/Parallel/<a class="el" href="a05135.html">vtkSubCommunicator.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:37:28 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
>
1648
