Sophie

Sophie

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

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: vtkPBGLBreadthFirstSearch 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&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 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&nbsp;List</span></a></li>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>vtkPBGLBreadthFirstSearch Class Reference</h1><!-- doxytag: class="vtkPBGLBreadthFirstSearch" --><!-- doxytag: inherits="vtkGraphAlgorithm" --><code>#include &lt;<a class="el" href="a05097.html">vtkPBGLBreadthFirstSearch.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for vtkPBGLBreadthFirstSearch:</div>
<div class="dynsection">
<p><center><img src="a12835.png" border="0" usemap="#a12836" alt="Inheritance graph"></center>
<map name="a12836">
<area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="35,229,171,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="53,155,152,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="63,80,143,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="48,5,157,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkPBGLBreadthFirstSearch:</div>
<div class="dynsection">
<p><center><img src="a12837.png" border="0" usemap="#a12838" alt="Collaboration graph"></center>
<map name="a12838">
<area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="408,512,544,539"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="261,395,360,421"><area shape="rect" href="a00472.html" title="Superclass for all pipeline executives in VTK." alt="" coords="65,512,164,539"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="91,187,171,213"><area shape="rect" href="a00895.html" title="Store zero or more vtkInformation instances." alt="" coords="56,277,205,304"><area shape="rect" href="a00872.html" title="Store vtkAlgorithm input/output information." alt="" coords="321,277,431,304"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="388,5,497,32"><area shape="rect" href="a00884.html" title="internal structure for vtkInformation" alt="" coords="400,187,563,213"><area shape="rect" href="a00886.html" title="Superclass for vtkInformation keys." alt="" coords="301,96,432,123"><area shape="rect" href="a01810.html" title="A atomic type representing the union of many types." alt="" coords="559,96,641,123"><area shape="rect" href="a01719.html" title="record modification and/or execution time" alt="" coords="168,96,277,123"><area shape="rect" href="a00891.html" title="Key for pointer to pointer." alt="" coords="195,187,376,213"><area shape="rect" href="a01607.html" title="Wrapper around vtkstd::string to keep symbols short." alt="" coords="572,5,668,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="a12839.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Breadth-first search on a distributed <a class="el" href="a00654.html" title="Base class for graph data types.">vtkGraph</a>. 
<p>
This VTK class uses the Parallel BGL breadth_first_search generic algorithm to perform a breadth first search from a given a 'source' vertex on the input graph (a distributed <a class="el" href="a00654.html" title="Base class for graph data types.">vtkGraph</a>).<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00654.html" title="Base class for graph data types.">vtkGraph</a> <a class="el" href="a00183.html" title="Boost breadth_first_search on a vtkGraph.">vtkBoostBreadthFirstSearch</a> vtkBoostGraphAdapter</dd></dl>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkPBGLBreadthFirstSearch">vtkPBGLBreadthFirstSearch (Tests)</a> </dd></dl>

<p>Definition at line <a class="el" href="a05097.html#l00047">47</a> of file <a class="el" href="a05097.html">vtkPBGLBreadthFirstSearch.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="a00656.html">vtkGraphAlgorithm</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#7734f5176d32b845c353aa7d7a71936f">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 *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#72e3a458b0f85d9dfda4a77f5ccaa4e9">GetClassName</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#2d5c5ffb3fd84c6f1d87f33fc229ff1a">IsA</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#91022605bfb4c04d88ac76eb5b38adfb">PrintSelf</a> (ostream &amp;os, <a class="el" href="a00869.html">vtkIndent</a> indent)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#5bb81f06dbdb83eba9d6e52348fe3226">SetOriginVertex</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> index)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#cc4fab212658228b45f1f24770de993e">SetOriginVertexString</a> (char *arrayName, char *value)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#7e80a29e20895b994ed2398db90231d1">SetOriginSelection</a> (<a class="el" href="a01522.html">vtkSelection</a> *s)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#7ff84744d48a1d0c73b4d7bce79a64ac">SetOriginSelectionConnection</a> (<a class="el" href="a00102.html">vtkAlgorithmOutput</a> *algOutput)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#b8509ebf761b12ce7e3b1e696a2259e9">SetOriginVertex</a> (<a class="el" href="a01607.html">vtkStdString</a> arrayName, <a class="el" href="a01810.html">vtkVariant</a> value)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#0cb7b1e9300c4028ec856f56e6d6cd9f">SetOutputArrayName</a> (const char *)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#562f4c91db5305c1a9ce0438a3118640">SetOriginFromSelection</a> (bool)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#1a74ea8c947ffafd1fe04f1be2140b53">GetOriginFromSelection</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#ea65f0990c92285285cf2a3695466243">OriginFromSelectionOn</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#b2dd62153e3451209485ee4ef532069c">OriginFromSelectionOff</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#2b8cf96e394bb9285d9e3c5117c626d1">GetOutputSelection</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#55e18147aa1deb428be9432302b39679">SetOutputSelection</a> (bool)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#008b67d88e8b25f94c3782d5922578f3">OutputSelectionOn</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#8108bc1bb860f8e1119f97bad2872148">OutputSelectionOff</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#5e0c2945c4f05a75f26c66c15f51a7b7">SetOutputSelectionType</a> (const char *)</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="a01183.html">vtkPBGLBreadthFirstSearch</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#33c07b96f0fa81cb5bd7422304d18db5">New</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#ff6e34ee7ac48f615f6a9d5326681edb">IsTypeOf</a> (const char *type)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01183.html">vtkPBGLBreadthFirstSearch</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#e495d9dd54c3051b028cf253a8c3555b">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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#6e063dfb89cd3959d7711b037abc3422">vtkPBGLBreadthFirstSearch</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#b36f9f578aef33cfc3c144569c8e6f92">~vtkPBGLBreadthFirstSearch</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#35f37d8eb5b55e10e0965f27430a315b">RequestData</a> (<a class="el" href="a00872.html">vtkInformation</a> *, <a class="el" href="a00895.html">vtkInformationVector</a> **, <a class="el" href="a00895.html">vtkInformationVector</a> *)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#4ccbc735824ff1a13cc4d78b98d9683d">FillInputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a01183.html#4f7437f83b9f4525ff2fb4618adab710">FillOutputPortInformation</a> (int port, <a class="el" href="a00872.html">vtkInformation</a> *info)</td></tr>

</table>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="7734f5176d32b845c353aa7d7a71936f"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::Superclass" ref="7734f5176d32b845c353aa7d7a71936f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="a00656.html">vtkGraphAlgorithm</a> <a class="el" href="a00656.html">vtkPBGLBreadthFirstSearch::Superclass</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00656.html#65ff0af97f9d847799accd57f8814926">vtkGraphAlgorithm</a>.</p>

<p>Definition at line <a class="el" href="a05097.html#l00051">51</a> of file <a class="el" href="a05097.html">vtkPBGLBreadthFirstSearch.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="6e063dfb89cd3959d7711b037abc3422"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::vtkPBGLBreadthFirstSearch" ref="6e063dfb89cd3959d7711b037abc3422" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkPBGLBreadthFirstSearch::vtkPBGLBreadthFirstSearch           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="b36f9f578aef33cfc3c144569c8e6f92"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::~vtkPBGLBreadthFirstSearch" ref="b36f9f578aef33cfc3c144569c8e6f92" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">vtkPBGLBreadthFirstSearch::~vtkPBGLBreadthFirstSearch           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="33c07b96f0fa81cb5bd7422304d18db5"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::New" ref="33c07b96f0fa81cb5bd7422304d18db5" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01183.html">vtkPBGLBreadthFirstSearch</a>* vtkPBGLBreadthFirstSearch::New           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="a00656.html#1cff1f253656090acf628631b4e0b36e">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="72e3a458b0f85d9dfda4a77f5ccaa4e9"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::GetClassName" ref="72e3a458b0f85d9dfda4a77f5ccaa4e9" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual const char* vtkPBGLBreadthFirstSearch::GetClassName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00656.html#19fd761c1a7702d463ecd187d224ddef">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="ff6e34ee7ac48f615f6a9d5326681edb"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::IsTypeOf" ref="ff6e34ee7ac48f615f6a9d5326681edb" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int vtkPBGLBreadthFirstSearch::IsTypeOf           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</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="a00656.html#82cb3fc0686797578cce635b27df2b2e">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="2d5c5ffb3fd84c6f1d87f33fc229ff1a"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::IsA" ref="2d5c5ffb3fd84c6f1d87f33fc229ff1a" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkPBGLBreadthFirstSearch::IsA           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</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="a00656.html#d7389dfdd1ab2579c3109c589b6a2a5d">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="e495d9dd54c3051b028cf253a8c3555b"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SafeDownCast" ref="e495d9dd54c3051b028cf253a8c3555b" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="a01183.html">vtkPBGLBreadthFirstSearch</a>* vtkPBGLBreadthFirstSearch::SafeDownCast           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01084.html">vtkObject</a> *&nbsp;</td>
          <td class="paramname"> <em>o</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Reimplemented from <a class="el" href="a00656.html#f837b1caa1cdbb31f677e59af1a8895c">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="91022605bfb4c04d88ac76eb5b38adfb"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::PrintSelf" ref="91022605bfb4c04d88ac76eb5b38adfb" args="(ostream &amp;os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkPBGLBreadthFirstSearch::PrintSelf           </td>
          <td>(</td>
          <td class="paramtype">ostream &amp;&nbsp;</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>&nbsp;</td>
          <td class="paramname"> <em>indent</em></td><td>&nbsp;</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="a00656.html#f107f75f6b708a81fe0bf11114824a71">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="7e80a29e20895b994ed2398db90231d1"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOriginSelection" ref="7e80a29e20895b994ed2398db90231d1" args="(vtkSelection *s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkPBGLBreadthFirstSearch::SetOriginSelection           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01522.html">vtkSelection</a> *&nbsp;</td>
          <td class="paramname"> <em>s</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience methods for setting the origin selection input. 
</div>
</div><p>
<a class="anchor" name="7ff84744d48a1d0c73b4d7bce79a64ac"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOriginSelectionConnection" ref="7ff84744d48a1d0c73b4d7bce79a64ac" args="(vtkAlgorithmOutput *algOutput)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkPBGLBreadthFirstSearch::SetOriginSelectionConnection           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00102.html">vtkAlgorithmOutput</a> *&nbsp;</td>
          <td class="paramname"> <em>algOutput</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience methods for setting the origin selection input. 
<p>Definition at line <a class="el" href="a05097.html#l00057">57</a> of file <a class="el" href="a05097.html">vtkPBGLBreadthFirstSearch.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="5bb81f06dbdb83eba9d6e52348fe3226"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOriginVertex" ref="5bb81f06dbdb83eba9d6e52348fe3226" args="(vtkIdType index)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkPBGLBreadthFirstSearch::SetOriginVertex           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a>&nbsp;</td>
          <td class="paramname"> <em>index</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the index (into the vertex array) of the breadth first search 'origin' vertex. 
</div>
</div><p>
<a class="anchor" name="b8509ebf761b12ce7e3b1e696a2259e9"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOriginVertex" ref="b8509ebf761b12ce7e3b1e696a2259e9" args="(vtkStdString arrayName, vtkVariant value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkPBGLBreadthFirstSearch::SetOriginVertex           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a01607.html">vtkStdString</a>&nbsp;</td>
          <td class="paramname"> <em>arrayName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a01810.html">vtkVariant</a>&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the breadth first search 'origin' vertex. This method is basically the same as above but allows the application to simply specify an array name and value, instead of having to know the specific index of the vertex. 
</div>
</div><p>
<a class="anchor" name="cc4fab212658228b45f1f24770de993e"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOriginVertexString" ref="cc4fab212658228b45f1f24770de993e" args="(char *arrayName, char *value)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void vtkPBGLBreadthFirstSearch::SetOriginVertexString           </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>arrayName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convenience method for setting the origin vertex given an array name and string value. This method is primarily for the benefit of the VTK Parallel client/server layer, callers should prefer to use <a class="el" href="a01183.html#5bb81f06dbdb83eba9d6e52348fe3226">SetOriginVertex()</a> whenever possible. 
</div>
</div><p>
<a class="anchor" name="0cb7b1e9300c4028ec856f56e6d6cd9f"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOutputArrayName" ref="0cb7b1e9300c4028ec856f56e6d6cd9f" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::SetOutputArrayName           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the output array name. If no output array name is set then the name 'BFS' is used. 
</div>
</div><p>
<a class="anchor" name="562f4c91db5305c1a9ce0438a3118640"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOriginFromSelection" ref="562f4c91db5305c1a9ce0438a3118640" args="(bool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::SetOriginFromSelection           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Use the <a class="el" href="a01522.html" title="A node in a selection tree. Used to store selection results.">vtkSelection</a> from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)). 
</div>
</div><p>
<a class="anchor" name="1a74ea8c947ffafd1fe04f1be2140b53"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::GetOriginFromSelection" ref="1a74ea8c947ffafd1fe04f1be2140b53" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool vtkPBGLBreadthFirstSearch::GetOriginFromSelection           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Use the <a class="el" href="a01522.html" title="A node in a selection tree. Used to store selection results.">vtkSelection</a> from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)). 
</div>
</div><p>
<a class="anchor" name="ea65f0990c92285285cf2a3695466243"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::OriginFromSelectionOn" ref="ea65f0990c92285285cf2a3695466243" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::OriginFromSelectionOn           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Use the <a class="el" href="a01522.html" title="A node in a selection tree. Used to store selection results.">vtkSelection</a> from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)). 
</div>
</div><p>
<a class="anchor" name="b2dd62153e3451209485ee4ef532069c"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::OriginFromSelectionOff" ref="b2dd62153e3451209485ee4ef532069c" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::OriginFromSelectionOff           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Use the <a class="el" href="a01522.html" title="A node in a selection tree. Used to store selection results.">vtkSelection</a> from input port 1 as the origin vertex. The selection should be a IDS selection with field type POINTS. The first ID in the selection will be used for the origin vertex. Default is off (origin is specified by SetOriginVertex(...)). 
</div>
</div><p>
<a class="anchor" name="2b8cf96e394bb9285d9e3c5117c626d1"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::GetOutputSelection" ref="2b8cf96e394bb9285d9e3c5117c626d1" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool vtkPBGLBreadthFirstSearch::GetOutputSelection           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off. 
</div>
</div><p>
<a class="anchor" name="55e18147aa1deb428be9432302b39679"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOutputSelection" ref="55e18147aa1deb428be9432302b39679" args="(bool)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::SetOutputSelection           </td>
          <td>(</td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off. 
</div>
</div><p>
<a class="anchor" name="008b67d88e8b25f94c3782d5922578f3"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::OutputSelectionOn" ref="008b67d88e8b25f94c3782d5922578f3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::OutputSelectionOn           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off. 
</div>
</div><p>
<a class="anchor" name="8108bc1bb860f8e1119f97bad2872148"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::OutputSelectionOff" ref="8108bc1bb860f8e1119f97bad2872148" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::OutputSelectionOff           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an output selection containing the ID of a vertex based on the output selection type. The default is to use the the maximum distance from the starting vertex. Defaults to off. 
</div>
</div><p>
<a class="anchor" name="5e0c2945c4f05a75f26c66c15f51a7b7"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::SetOutputSelectionType" ref="5e0c2945c4f05a75f26c66c15f51a7b7" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void vtkPBGLBreadthFirstSearch::SetOutputSelectionType           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the output selection type. The default is to use the the maximum distance from the starting vertex "MAX_DIST_FROM_ROOT". But you can also specify other things like "ROOT","2D_MAX", etc 
</div>
</div><p>
<a class="anchor" name="35f37d8eb5b55e10e0965f27430a315b"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::RequestData" ref="35f37d8eb5b55e10e0965f27430a315b" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkPBGLBreadthFirstSearch::RequestData           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname"> <em>request</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> **&nbsp;</td>
          <td class="paramname"> <em>inputVector</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00895.html">vtkInformationVector</a> *&nbsp;</td>
          <td class="paramname"> <em>outputVector</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
This is called by the superclass. This is the method you should override. 
<p>Reimplemented from <a class="el" href="a00656.html#adc44af7541c6076e3953a94e9477abf">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="4ccbc735824ff1a13cc4d78b98d9683d"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::FillInputPortInformation" ref="4ccbc735824ff1a13cc4d78b98d9683d" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkPBGLBreadthFirstSearch::FillInputPortInformation           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname"> <em>info</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle. 
<p>Reimplemented from <a class="el" href="a00656.html#2119e6b6b3b5be8c1389da0e84b2c235">vtkGraphAlgorithm</a>.</p>

</div>
</div><p>
<a class="anchor" name="4f7437f83b9f4525ff2fb4618adab710"></a><!-- doxytag: member="vtkPBGLBreadthFirstSearch::FillOutputPortInformation" ref="4f7437f83b9f4525ff2fb4618adab710" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int vtkPBGLBreadthFirstSearch::FillOutputPortInformation           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>port</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> *&nbsp;</td>
          <td class="paramname"> <em>info</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Fill the output port information objects for this algorithm. This is invoked by the first call to GetOutputPortInformation for each port so subclasses can specify what they can handle. 
<p>Reimplemented from <a class="el" href="a00656.html#3b5a83dfee2bbd4484e7902a77397746">vtkGraphAlgorithm</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="a05097.html">vtkPBGLBreadthFirstSearch.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:22:57 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>