<!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: vtkPBGLShortestPaths 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>vtkPBGLShortestPaths Class Reference</h1><!-- doxytag: class="vtkPBGLShortestPaths" --><!-- doxytag: inherits="vtkGraphAlgorithm" --><code>#include <<a class="el" href="a05108.html">vtkPBGLShortestPaths.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for vtkPBGLShortestPaths:</div>
<div class="dynsection">
<p><center><img src="a12885.png" border="0" usemap="#a12886" alt="Inheritance graph"></center>
<map name="a12886">
<area shape="rect" href="a00656.html" title="Superclass for algorithms that produce only graph as output." alt="" coords="19,229,155,256"><area shape="rect" href="a00101.html" title="Superclass for all sources, filters, and sinks in VTK." alt="" coords="37,155,136,181"><area shape="rect" href="a01084.html" title="abstract base class for most VTK objects" alt="" coords="47,80,127,107"><area shape="rect" href="a01085.html" title="abstract base class for most VTK objects" alt="" coords="32,5,141,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<div class="dynheader">
Collaboration diagram for vtkPBGLShortestPaths:</div>
<div class="dynsection">
<p><center><img src="a12887.png" border="0" usemap="#a12888" alt="Collaboration graph"></center>
<map name="a12888">
<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="a12889.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
Compute the shortest paths from the origin vertex to all other vertices in 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's implementation of the delta-stepping algorithm generic algorithm to compute shortest paths from a given 'source' vertex on the input graph (a distributed <a class="el" href="a00654.html" title="Base class for graph data types.">vtkGraph</a>). Delta-stepping, discovered by Meyer and Sanders, is a parallel form of Dijkstra's shortest paths algorithm, based on a multi-level bucket structure that permits edges to be relaxed in parallel.<p>
<dl class="user" compact><dt><b>Tests:</b></dt><dd><a class="el" href="c2_vtk_t_12.html#c2_vtk_t_vtkPBGLShortestPaths">vtkPBGLShortestPaths (Tests)</a> </dd></dl>
<p>Definition at line <a class="el" href="a05108.html#l00047">47</a> of file <a class="el" href="a05108.html">vtkPBGLShortestPaths.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> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#3ffcb08b32213892489318f2082ba626">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="a01194.html#ad640d21569d0e4efc7b9da29a68f833">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="a01194.html#11a58b7d7b57980b99afbbb167c65148">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="a01194.html#6b1b0c197d1805ec4c46b128b583e9ca">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="a01194.html#af6607a34ab09730586ca73b3f55d818">SetOriginVertex</a> (<a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#38e165075f788b82ec6a25258c3d07fd">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#486997e4cfbf2ecd76068b3ab79a291c">SetOriginSelection</a> (<a class="el" href="a01522.html">vtkSelection</a> *s)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#70f7252c9dba144266dfe06df4ca6d7b">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#d5945b337e9c5979a4edaed247670b11">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#d8e1f5a2bb9f4f6346baa0c182ad856e">SetEdgeWeightArrayName</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#1688a65b6b0a2573559d324daef5a21c">SetDelta</a> (double)</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#07d3cf3138d1e307a461322a434abaf1">SetPredecessorArrayName</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#5df4e509ca6ac53fe9d99d35632eb2d6">SetPathLengthArrayName</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#ba111fd6ab098d76f44565923f25c98e">SetOriginFromSelection</a> (bool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#bf2c75daa662782f088220dcdf9351f2">GetOriginFromSelection</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#36ab22b1bcbcb92566d17b04082fab08">OriginFromSelectionOn</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#9562f01b9f5a16a2ee4c992ba200c234">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#a3af2b6046c55e50b31d5444496ed576">GetOutputSelection</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#98c58fdcbddb0d98617d660a85f214dd">SetOutputSelection</a> (bool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#a3be86d0348b3fff10b1f4e63fb06f54">OutputSelectionOn</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#1e77485f0e358da0e96d554225162891">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#7c3a898ce3b389dbc135994304915d33">SetOutputSelectionType</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#a4069022ccc1523c3c31d1aba56d9eeb">SetUseUniformEdgeWeights</a> (bool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#5aba540e14cb90f44ce62ab3147fb079">GetUseUniformEdgeWeights</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#64bb48c5358dd5b1f4ab91db62e77e9f">UseUniformEdgeWeightsOn</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#21e6b370bbe741889933b7884c67dba3">UseUniformEdgeWeightsOff</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="a01194.html">vtkPBGLShortestPaths</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#888200e68387eecc23d8fea3f43f9e0c">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="a01194.html#426afdd7f40809876517213016b70637">IsTypeOf</a> (const char *type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a01194.html">vtkPBGLShortestPaths</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#36d05f32e12b8a7c8ab63cb466881bd0">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="a01194.html#bda40cf41d3f52c1f75c8c7408bd36b2">vtkPBGLShortestPaths</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#ef7d37ab9b339e585cac906615424ed6">~vtkPBGLShortestPaths</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#c348a072a1bd50b645158b862b2c64d6">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#7ce8565736b27e55e127a94a9fabbb6f">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 </td><td class="memItemRight" valign="bottom"><a class="el" href="a01194.html#6aafb65cd5c0c10bfccc96c9080bb43b">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="3ffcb08b32213892489318f2082ba626"></a><!-- doxytag: member="vtkPBGLShortestPaths::Superclass" ref="3ffcb08b32213892489318f2082ba626" 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">vtkPBGLShortestPaths::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="a05108.html#l00051">51</a> of file <a class="el" href="a05108.html">vtkPBGLShortestPaths.h</a>.</p>
</div>
</div><p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="bda40cf41d3f52c1f75c8c7408bd36b2"></a><!-- doxytag: member="vtkPBGLShortestPaths::vtkPBGLShortestPaths" ref="bda40cf41d3f52c1f75c8c7408bd36b2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPBGLShortestPaths::vtkPBGLShortestPaths </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="ef7d37ab9b339e585cac906615424ed6"></a><!-- doxytag: member="vtkPBGLShortestPaths::~vtkPBGLShortestPaths" ref="ef7d37ab9b339e585cac906615424ed6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vtkPBGLShortestPaths::~vtkPBGLShortestPaths </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="888200e68387eecc23d8fea3f43f9e0c"></a><!-- doxytag: member="vtkPBGLShortestPaths::New" ref="888200e68387eecc23d8fea3f43f9e0c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01194.html">vtkPBGLShortestPaths</a>* vtkPBGLShortestPaths::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="a00656.html#1cff1f253656090acf628631b4e0b36e">vtkGraphAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="ad640d21569d0e4efc7b9da29a68f833"></a><!-- doxytag: member="vtkPBGLShortestPaths::GetClassName" ref="ad640d21569d0e4efc7b9da29a68f833" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* vtkPBGLShortestPaths::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="a00656.html#19fd761c1a7702d463ecd187d224ddef">vtkGraphAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="426afdd7f40809876517213016b70637"></a><!-- doxytag: member="vtkPBGLShortestPaths::IsTypeOf" ref="426afdd7f40809876517213016b70637" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static int vtkPBGLShortestPaths::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="a00656.html#82cb3fc0686797578cce635b27df2b2e">vtkGraphAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="11a58b7d7b57980b99afbbb167c65148"></a><!-- doxytag: member="vtkPBGLShortestPaths::IsA" ref="11a58b7d7b57980b99afbbb167c65148" args="(const char *type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkPBGLShortestPaths::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="a00656.html#d7389dfdd1ab2579c3109c589b6a2a5d">vtkGraphAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="36d05f32e12b8a7c8ab63cb466881bd0"></a><!-- doxytag: member="vtkPBGLShortestPaths::SafeDownCast" ref="36d05f32e12b8a7c8ab63cb466881bd0" args="(vtkObject *o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a01194.html">vtkPBGLShortestPaths</a>* vtkPBGLShortestPaths::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="a00656.html#f837b1caa1cdbb31f677e59af1a8895c">vtkGraphAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="6b1b0c197d1805ec4c46b128b583e9ca"></a><!-- doxytag: member="vtkPBGLShortestPaths::PrintSelf" ref="6b1b0c197d1805ec4c46b128b583e9ca" args="(ostream &os, vtkIndent indent)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPBGLShortestPaths::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="a00656.html#f107f75f6b708a81fe0bf11114824a71">vtkGraphAlgorithm</a>.</p>
</div>
</div><p>
<a class="anchor" name="486997e4cfbf2ecd76068b3ab79a291c"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOriginSelection" ref="486997e4cfbf2ecd76068b3ab79a291c" args="(vtkSelection *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPBGLShortestPaths::SetOriginSelection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01522.html">vtkSelection</a> * </td>
<td class="paramname"> <em>s</em> </td>
<td> ) </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="70f7252c9dba144266dfe06df4ca6d7b"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOriginSelectionConnection" ref="70f7252c9dba144266dfe06df4ca6d7b" args="(vtkAlgorithmOutput *algOutput)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPBGLShortestPaths::SetOriginSelectionConnection </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00102.html">vtkAlgorithmOutput</a> * </td>
<td class="paramname"> <em>algOutput</em> </td>
<td> ) </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="a05108.html#l00057">57</a> of file <a class="el" href="a05108.html">vtkPBGLShortestPaths.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="af6607a34ab09730586ca73b3f55d818"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOriginVertex" ref="af6607a34ab09730586ca73b3f55d818" args="(vtkIdType index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPBGLShortestPaths::SetOriginVertex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a02149.html#20bd6b6dedfe1bbb096c50354d52cc7e">vtkIdType</a> </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </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="d5945b337e9c5979a4edaed247670b11"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOriginVertex" ref="d5945b337e9c5979a4edaed247670b11" args="(vtkStdString arrayName, vtkVariant value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPBGLShortestPaths::SetOriginVertex </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a01607.html">vtkStdString</a> </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> </td>
<td class="paramname"> <em>value</em></td><td> </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="38e165075f788b82ec6a25258c3d07fd"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOriginVertexString" ref="38e165075f788b82ec6a25258c3d07fd" args="(char *arrayName, char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void vtkPBGLShortestPaths::SetOriginVertexString </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>arrayName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>value</em></td><td> </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="a01194.html#af6607a34ab09730586ca73b3f55d818">SetOriginVertex()</a> whenever possible.
</div>
</div><p>
<a class="anchor" name="d8e1f5a2bb9f4f6346baa0c182ad856e"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetEdgeWeightArrayName" ref="d8e1f5a2bb9f4f6346baa0c182ad856e" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetEdgeWeightArrayName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the name of the edge-weight input array, which must name an array that is part of the edge data of the input graph and contains numeric data. If the edge-weight array is not of type <a class="el" href="a00436.html" title="dynamic, self-adjusting array of double">vtkDoubleArray</a>, the array will be copied into a temporary <a class="el" href="a00436.html" title="dynamic, self-adjusting array of double">vtkDoubleArray</a>.
</div>
</div><p>
<a class="anchor" name="1688a65b6b0a2573559d324daef5a21c"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetDelta" ref="1688a65b6b0a2573559d324daef5a21c" args="(double)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetDelta </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the value of delta, which is the width of each "bucket" within the multi-level bucket structure used internally by this algorithm. Large values of delta correspond with wider buckets, exposing more parallelism than smaller values. However, values that are too large will cause the algorithm to compute (and, later, correct) paths that are longer than the shortest path. While the value of delta will not affect the correctness of the results of this algorithm, delta can have a significant impact on performance. If no value of delta is provided, this algorithm employs the heuristics provided by Meyer and Sanders to automatically determine a delta.
</div>
</div><p>
<a class="anchor" name="07d3cf3138d1e307a461322a434abaf1"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetPredecessorArrayName" ref="07d3cf3138d1e307a461322a434abaf1" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetPredecessorArrayName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the name of the predecessor output array, which contains the predecessor of each vertex within the shortest paths tree. To determine the shortest path from the origin to a particular vertex, walk the predecessor array backwards. If no predecessor array name is set then the name 'Predecessor' is used.
</div>
</div><p>
<a class="anchor" name="5df4e509ca6ac53fe9d99d35632eb2d6"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetPathLengthArrayName" ref="5df4e509ca6ac53fe9d99d35632eb2d6" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetPathLengthArrayName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the name of the shortest path length output array, containing the length of the shortest path from the origin vertex to each of the other vertices in the graph. The origin will always have path-length 0, while vertices unreachable from the origin will have infinite path-length. If no path length array name is set then the name 'PathLength' is used.
</div>
</div><p>
<a class="anchor" name="ba111fd6ab098d76f44565923f25c98e"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOriginFromSelection" ref="ba111fd6ab098d76f44565923f25c98e" args="(bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetOriginFromSelection </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> </td>
<td> ) </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="bf2c75daa662782f088220dcdf9351f2"></a><!-- doxytag: member="vtkPBGLShortestPaths::GetOriginFromSelection" ref="bf2c75daa662782f088220dcdf9351f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool vtkPBGLShortestPaths::GetOriginFromSelection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="36ab22b1bcbcb92566d17b04082fab08"></a><!-- doxytag: member="vtkPBGLShortestPaths::OriginFromSelectionOn" ref="36ab22b1bcbcb92566d17b04082fab08" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::OriginFromSelectionOn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="9562f01b9f5a16a2ee4c992ba200c234"></a><!-- doxytag: member="vtkPBGLShortestPaths::OriginFromSelectionOff" ref="9562f01b9f5a16a2ee4c992ba200c234" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::OriginFromSelectionOff </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="a3af2b6046c55e50b31d5444496ed576"></a><!-- doxytag: member="vtkPBGLShortestPaths::GetOutputSelection" ref="a3af2b6046c55e50b31d5444496ed576" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool vtkPBGLShortestPaths::GetOutputSelection </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="98c58fdcbddb0d98617d660a85f214dd"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOutputSelection" ref="98c58fdcbddb0d98617d660a85f214dd" args="(bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetOutputSelection </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> </td>
<td> ) </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="a3be86d0348b3fff10b1f4e63fb06f54"></a><!-- doxytag: member="vtkPBGLShortestPaths::OutputSelectionOn" ref="a3be86d0348b3fff10b1f4e63fb06f54" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::OutputSelectionOn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="1e77485f0e358da0e96d554225162891"></a><!-- doxytag: member="vtkPBGLShortestPaths::OutputSelectionOff" ref="1e77485f0e358da0e96d554225162891" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::OutputSelectionOff </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </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="7c3a898ce3b389dbc135994304915d33"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetOutputSelectionType" ref="7c3a898ce3b389dbc135994304915d33" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetOutputSelectionType </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> </td>
<td> ) </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="a4069022ccc1523c3c31d1aba56d9eeb"></a><!-- doxytag: member="vtkPBGLShortestPaths::SetUseUniformEdgeWeights" ref="a4069022ccc1523c3c31d1aba56d9eeb" args="(bool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::SetUseUniformEdgeWeights </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.
</div>
</div><p>
<a class="anchor" name="5aba540e14cb90f44ce62ab3147fb079"></a><!-- doxytag: member="vtkPBGLShortestPaths::GetUseUniformEdgeWeights" ref="5aba540e14cb90f44ce62ab3147fb079" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool vtkPBGLShortestPaths::GetUseUniformEdgeWeights </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.
</div>
</div><p>
<a class="anchor" name="64bb48c5358dd5b1f4ab91db62e77e9f"></a><!-- doxytag: member="vtkPBGLShortestPaths::UseUniformEdgeWeightsOn" ref="64bb48c5358dd5b1f4ab91db62e77e9f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::UseUniformEdgeWeightsOn </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.
</div>
</div><p>
<a class="anchor" name="21e6b370bbe741889933b7884c67dba3"></a><!-- doxytag: member="vtkPBGLShortestPaths::UseUniformEdgeWeightsOff" ref="21e6b370bbe741889933b7884c67dba3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void vtkPBGLShortestPaths::UseUniformEdgeWeightsOff </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This option causes a temporary edge-weight array to be created with uniform edge weights of 1.0 at each edge. This option should preempt a given edge weight array via EdgeWeightArrayName. Defaults to off.
</div>
</div><p>
<a class="anchor" name="c348a072a1bd50b645158b862b2c64d6"></a><!-- doxytag: member="vtkPBGLShortestPaths::RequestData" ref="c348a072a1bd50b645158b862b2c64d6" args="(vtkInformation *, vtkInformationVector **, vtkInformationVector *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkPBGLShortestPaths::RequestData </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00872.html">vtkInformation</a> * </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> ** </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> * </td>
<td class="paramname"> <em>outputVector</em></td><td> </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="7ce8565736b27e55e127a94a9fabbb6f"></a><!-- doxytag: member="vtkPBGLShortestPaths::FillInputPortInformation" ref="7ce8565736b27e55e127a94a9fabbb6f" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkPBGLShortestPaths::FillInputPortInformation </td>
<td>(</td>
<td class="paramtype">int </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> * </td>
<td class="paramname"> <em>info</em></td><td> </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="6aafb65cd5c0c10bfccc96c9080bb43b"></a><!-- doxytag: member="vtkPBGLShortestPaths::FillOutputPortInformation" ref="6aafb65cd5c0c10bfccc96c9080bb43b" args="(int port, vtkInformation *info)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int vtkPBGLShortestPaths::FillOutputPortInformation </td>
<td>(</td>
<td class="paramtype">int </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> * </td>
<td class="paramname"> <em>info</em></td><td> </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="a05108.html">vtkPBGLShortestPaths.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jun 3 19:23:12 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
>
1197
