Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > 60f1dc962abad0f3b492991a4fbef9be > files > 4033

vtk-doc-5.4.2-5mdv2010.0.noarch.rpm

<!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: dox/Filtering/vtkDistributedGraphHelper.h Source File</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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="classes.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
<h1>dox/Filtering/vtkDistributedGraphHelper.h</h1><a href="a02241.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment">  Program:   Visualization Toolkit</span>
<a name="l00004"></a>00004 <span class="comment">  Module:    $RCSfile: vtkDistributedGraphHelper.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen</span>
<a name="l00007"></a>00007 <span class="comment">  All rights reserved.</span>
<a name="l00008"></a>00008 <span class="comment">  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">     This software is distributed WITHOUT ANY WARRANTY; without even</span>
<a name="l00011"></a>00011 <span class="comment">     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR</span>
<a name="l00012"></a>00012 <span class="comment">     PURPOSE.  See the above copyright notice for more information.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">=========================================================================*/</span>
<a name="l00015"></a>00015 <span class="comment">/*</span>
<a name="l00016"></a>00016 <span class="comment"> * Copyright (C) 2008 The Trustees of Indiana University.</span>
<a name="l00017"></a>00017 <span class="comment"> * Use, modification and distribution is subject to the Boost Software</span>
<a name="l00018"></a>00018 <span class="comment"> * License, Version 1.0. (See http://www.boost.org/LICENSE_1_0.txt)</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020 
<a name="l00055"></a>00055 <span class="preprocessor">#ifndef __vtkDistributedGraphHelper_h</span>
<a name="l00056"></a>00056 <span class="preprocessor"></span><span class="preprocessor">#define __vtkDistributedGraphHelper_h</span>
<a name="l00057"></a>00057 <span class="preprocessor"></span>
<a name="l00058"></a>00058 <span class="preprocessor">#include "<a class="code" href="a02079.html">vtkObject.h</a>"</span>
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="keyword">class </span>vtkDistributedGraphHelperInternals;
<a name="l00061"></a>00061 <span class="keyword">struct </span><a class="code" href="a00454.html">vtkEdgeType</a>;
<a name="l00062"></a>00062 <span class="keyword">class </span><a class="code" href="a00654.html" title="Base class for graph data types.">vtkGraph</a>;
<a name="l00063"></a>00063 <span class="keyword">class </span><a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>;
<a name="l00064"></a>00064 <span class="keyword">class </span><a class="code" href="a01811.html" title="An array holding vtkVariants.">vtkVariantArray</a>;
<a name="l00065"></a>00065 <span class="keyword">class </span><a class="code" href="a00881.html" title="Key for integer values in vtkInformation.">vtkInformationIntegerKey</a>;
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <span class="comment">// .NAME vtkVertexPedigreeIdDistributionFunction - The type of a</span>
<a name="l00068"></a>00068 <span class="comment">// function used to determine how to distribute vertex pedigree IDs</span>
<a name="l00069"></a>00069 <span class="comment">// across processors in a vtkGraph. The pedigree ID distribution</span>
<a name="l00070"></a>00070 <span class="comment">// function takes the pedigree ID of the vertex and a user-supplied</span>
<a name="l00071"></a>00071 <span class="comment">// void pointer and returns a hash value V. A vertex with that</span>
<a name="l00072"></a>00072 <span class="comment">// pedigree ID will reside on processor V % P, where P is the number</span>
<a name="l00073"></a>00073 <span class="comment">// of processors. This type is used in conjunction with the</span>
<a name="l00074"></a>00074 <span class="comment">// vtkDistributedGraphHelper class.</span>
<a name="l00075"></a>00075 <span class="keyword">typedef</span> <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> (*<a class="code" href="a02241.html#bfc7612028ec4771896cf3fc362e60c2">vtkVertexPedigreeIdDistribution</a>)
<a name="l00076"></a><a class="code" href="a02241.html#bfc7612028ec4771896cf3fc362e60c2">00076</a>           (<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; pedigreeId, <span class="keywordtype">void</span>* userData);
<a name="l00077"></a>00077 
<a name="l00078"></a><a class="code" href="a00433.html">00078</a> <span class="keyword">class </span><a class="code" href="a02170.html#95ced7977a6b6b1bf9f38bf04e3835b6">VTK_FILTERING_EXPORT</a> <a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a> : <span class="keyword">public</span> <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>
<a name="l00079"></a>00079 {
<a name="l00080"></a>00080  <span class="keyword">public</span>:
<a name="l00081"></a><a class="code" href="a00433.html#5b46ad74952ed22bbe6633af4106f85d">00081</a>   vtkTypeRevisionMacro (<a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a>, <a class="code" href="a01084.html" title="abstract base class for most VTK objects">vtkObject</a>);
<a name="l00082"></a>00082   <span class="keywordtype">void</span> <a class="code" href="a01084.html#bf3dbb4154289b56a12483eee3866263">PrintSelf</a>(ostream&amp; os, <a class="code" href="a00869.html" title="a simple class to control print indentation">vtkIndent</a> indent);
<a name="l00083"></a>00083 
<a name="l00085"></a>00085   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetVertexOwner(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> v) <span class="keyword">const</span>;
<a name="l00086"></a>00086 
<a name="l00089"></a>00089   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetVertexIndex(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> v) <span class="keyword">const</span>;
<a name="l00090"></a>00090 
<a name="l00093"></a>00093   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetEdgeOwner(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> e_id) <span class="keyword">const</span>;
<a name="l00094"></a>00094 
<a name="l00097"></a>00097   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetEdgeIndex(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> e_id) <span class="keyword">const</span>;
<a name="l00098"></a>00098 
<a name="l00101"></a>00101   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> MakeDistributedId(<span class="keywordtype">int</span> owner, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> local);
<a name="l00102"></a>00102 
<a name="l00104"></a>00104 
<a name="l00109"></a>00109   <span class="keywordtype">void</span> SetVertexPedigreeIdDistribution(<a class="code" href="a02241.html#bfc7612028ec4771896cf3fc362e60c2">vtkVertexPedigreeIdDistribution</a> Func,
<a name="l00110"></a>00110                                        <span class="keywordtype">void</span> *userData);
<a name="l00112"></a>00112 
<a name="l00113"></a>00113   <span class="comment">//BTX</span>
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> GetVertexOwnerByPedigreeId(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; pedigreeId);
<a name="l00117"></a>00117   <span class="comment">//ETX</span>
<a name="l00119"></a>00119 <span class="comment"></span>
<a name="l00126"></a>00126   <span class="keyword">virtual</span> <span class="keywordtype">void</span> Synchronize() = 0;
<a name="l00127"></a>00127 
<a name="l00130"></a>00130   <span class="keyword">virtual</span> <a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a> *Clone() = 0;
<a name="l00131"></a>00131 
<a name="l00133"></a>00133 
<a name="l00138"></a>00138   <span class="keyword">static</span> <a class="code" href="a00881.html" title="Key for integer values in vtkInformation.">vtkInformationIntegerKey</a> * DISTRIBUTEDVERTEXIDS();
<a name="l00139"></a>00139   <span class="keyword">static</span> <a class="code" href="a00881.html" title="Key for integer values in vtkInformation.">vtkInformationIntegerKey</a> * DISTRIBUTEDEDGEIDS();
<a name="l00141"></a>00141 
<a name="l00142"></a>00142  <span class="keyword">protected</span>:
<a name="l00143"></a>00143   <a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a>();
<a name="l00144"></a>00144   <span class="keyword">virtual</span> ~<a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a>();
<a name="l00145"></a>00145 
<a name="l00147"></a>00147 
<a name="l00152"></a>00152   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddVertexInternal(<a class="code" href="a01811.html" title="An array holding vtkVariants.">vtkVariantArray</a> *propertyArr,
<a name="l00153"></a>00153                          <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> *vertex) = 0;
<a name="l00155"></a>00155 
<a name="l00158"></a>00158   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddVertexInternal(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; pedigreeId, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> *vertex) = 0;
<a name="l00159"></a>00159 
<a name="l00161"></a>00161 
<a name="l00165"></a>00165   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddEdgeInternal(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> u, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> v, <span class="keywordtype">bool</span> directed,
<a name="l00166"></a>00166                                <a class="code" href="a01811.html" title="An array holding vtkVariants.">vtkVariantArray</a> *propertyArr,
<a name="l00167"></a>00167                                <a class="code" href="a00454.html">vtkEdgeType</a> *edge) = 0;
<a name="l00169"></a>00169 
<a name="l00171"></a>00171 
<a name="l00177"></a>00177   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddEdgeInternal(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; uPedigreeId, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> v,
<a name="l00178"></a>00178                                <span class="keywordtype">bool</span> directed, <a class="code" href="a01811.html" title="An array holding vtkVariants.">vtkVariantArray</a> *propertyArr,
<a name="l00179"></a>00179                                <a class="code" href="a00454.html">vtkEdgeType</a> *edge) = 0;
<a name="l00181"></a>00181 
<a name="l00183"></a>00183 
<a name="l00189"></a>00189   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddEdgeInternal(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> u, <span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; vPedigreeId,
<a name="l00190"></a>00190                                <span class="keywordtype">bool</span> directed, <a class="code" href="a01811.html" title="An array holding vtkVariants.">vtkVariantArray</a> *propertyArr,
<a name="l00191"></a>00191                                <a class="code" href="a00454.html">vtkEdgeType</a> *edge) = 0;
<a name="l00193"></a>00193 
<a name="l00195"></a>00195 
<a name="l00202"></a>00202   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AddEdgeInternal(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; uPedigreeId,
<a name="l00203"></a>00203                                <span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; vPedigreeId,
<a name="l00204"></a>00204                                <span class="keywordtype">bool</span> directed, <a class="code" href="a01811.html" title="An array holding vtkVariants.">vtkVariantArray</a> *propertyArr,
<a name="l00205"></a>00205                                <a class="code" href="a00454.html">vtkEdgeType</a> *edge) = 0;
<a name="l00207"></a>00207 
<a name="l00211"></a>00211   <span class="keyword">virtual</span> <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> FindVertex(<span class="keyword">const</span> <a class="code" href="a01810.html" title="A atomic type representing the union of many types.">vtkVariant</a>&amp; pedigreeId) = 0;
<a name="l00212"></a>00212 
<a name="l00214"></a>00214 
<a name="l00217"></a>00217   <span class="keyword">virtual</span> <span class="keywordtype">void</span>
<a name="l00218"></a>00218   FindEdgeSourceAndTarget(<a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> <span class="keywordtype">id</span>,
<a name="l00219"></a>00219                           <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> *<a class="code" href="a02995.html#7c22aa18a4e42c330618a6410d133551">source</a>, <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> *<a class="code" href="a02995.html#fc938df20cbcc0144ed508333af97623">target</a>) = 0;
<a name="l00221"></a>00221 
<a name="l00224"></a>00224   <span class="keyword">virtual</span> <span class="keywordtype">void</span> AttachToGraph(<a class="code" href="a00654.html" title="Base class for graph data types.">vtkGraph</a> *graph);
<a name="l00225"></a>00225 
<a name="l00227"></a><a class="code" href="a00433.html#d58762ff275da1acbb265354a60cb147">00227</a>   <a class="code" href="a00654.html" title="Base class for graph data types.">vtkGraph</a> *Graph;
<a name="l00228"></a>00228 
<a name="l00229"></a>00229   <span class="comment">//BTX</span>
<a name="l00231"></a><a class="code" href="a00433.html#5d432934945d869c1c23358e9f921919">00231</a> <span class="comment"></span>  <a class="code" href="a02241.html#bfc7612028ec4771896cf3fc362e60c2">vtkVertexPedigreeIdDistribution</a> VertexDistribution;
<a name="l00232"></a>00232 
<a name="l00235"></a><a class="code" href="a00433.html#ccdda9a0b6dd3c3eff49d7cf9ffd3429">00235</a>   <span class="keywordtype">void</span> *VertexDistributionUserData;
<a name="l00236"></a>00236 
<a name="l00238"></a><a class="code" href="a00433.html#9c0afc83b1de592342d6d93e57aa01f6">00238</a>   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> signBitMask;
<a name="l00239"></a>00239 
<a name="l00241"></a><a class="code" href="a00433.html#d705aa4422be736398cb6794e9446a50">00241</a>   <a class="code" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> highBitShiftMask;
<a name="l00242"></a>00242 
<a name="l00244"></a><a class="code" href="a00433.html#bfe4169cad5330039c549b5ba1ac85ad">00244</a>   <span class="keywordtype">int</span> procBits;
<a name="l00245"></a>00245 
<a name="l00247"></a>00247 
<a name="l00248"></a><a class="code" href="a00433.html#dede28dba86945485019f8812a33bf10">00248</a>   <span class="keywordtype">int</span> indexBits;
<a name="l00249"></a>00249   <span class="comment">//ETX</span>
<a name="l00251"></a>00251 <span class="comment"></span>
<a name="l00252"></a>00252  <span class="keyword">private</span>:
<a name="l00253"></a>00253   <a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a>(<span class="keyword">const</span> <a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a>&amp;); <span class="comment">// Not implemented</span>
<a name="l00254"></a>00254   <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="a00433.html" title="helper for the vtkGraph class that allows the graph to be distributed across multiple...">vtkDistributedGraphHelper</a>&amp;); <span class="comment">// Not implemented</span>
<a name="l00255"></a>00255 
<a name="l00256"></a>00256   <span class="comment">//BTX</span>
<a name="l00257"></a><a class="code" href="a00433.html#5f4fc8c20a4036140c2fd4dcb10d349f">00257</a>   <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="a00654.html" title="Base class for graph data types.">vtkGraph</a>;
<a name="l00258"></a>00258   <span class="comment">//ETX</span>
<a name="l00259"></a>00259 };
<a name="l00260"></a>00260 
<a name="l00261"></a>00261 <span class="preprocessor">#endif // __vtkDistributedGraphHelper_h</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 18:35:15 2009 for VTK by&nbsp;
<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>