Breadth-first search on a distributed vtkGraph. More...
#include <vtkPBGLBreadthFirstSearch.h>
Detailed Description
Breadth-first search on a distributed vtkGraph.
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 vtkGraph).
- See also:
- vtkGraph vtkBoostBreadthFirstSearch vtkBoostGraphAdapter
- Examples:
- vtkPBGLBreadthFirstSearch (Examples)
Definition at line 51 of file vtkPBGLBreadthFirstSearch.h.
Member Typedef Documentation
Reimplemented from vtkGraphAlgorithm.
Definition at line 55 of file vtkPBGLBreadthFirstSearch.h.
Constructor & Destructor Documentation
| vtkPBGLBreadthFirstSearch::vtkPBGLBreadthFirstSearch | ( | ) | [protected] |
| vtkPBGLBreadthFirstSearch::~vtkPBGLBreadthFirstSearch | ( | ) | [protected] |
Member Function Documentation
| static vtkPBGLBreadthFirstSearch* vtkPBGLBreadthFirstSearch::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkGraphAlgorithm.
| static int vtkPBGLBreadthFirstSearch::IsTypeOf | ( | const char * | name | ) | [static] |
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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkGraphAlgorithm.
| virtual int vtkPBGLBreadthFirstSearch::IsA | ( | const char * | name | ) | [virtual] |
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 vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkGraphAlgorithm.
| static vtkPBGLBreadthFirstSearch* vtkPBGLBreadthFirstSearch::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkGraphAlgorithm.
| virtual vtkObjectBase* vtkPBGLBreadthFirstSearch::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkGraphAlgorithm.
Reimplemented from vtkGraphAlgorithm.
| void vtkPBGLBreadthFirstSearch::PrintSelf | ( | ostream & | os, |
| vtkIndent | indent | ||
| ) | [virtual] |
Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkGraphAlgorithm.
Convenience methods for setting the origin selection input.
| void vtkPBGLBreadthFirstSearch::SetOriginSelectionConnection | ( | vtkAlgorithmOutput * | algOutput | ) | [inline] |
Convenience methods for setting the origin selection input.
Definition at line 61 of file vtkPBGLBreadthFirstSearch.h.
| void vtkPBGLBreadthFirstSearch::SetOriginVertex | ( | vtkIdType | index | ) |
Set the index (into the vertex array) of the breadth first search 'origin' vertex.
| void vtkPBGLBreadthFirstSearch::SetOriginVertex | ( | vtkStdString | arrayName, |
| vtkVariant | value | ||
| ) |
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.
| void vtkPBGLBreadthFirstSearch::SetOriginVertexString | ( | char * | arrayName, |
| char * | value | ||
| ) |
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 SetOriginVertex() whenever possible.
| virtual void vtkPBGLBreadthFirstSearch::SetOutputArrayName | ( | const char * | ) | [virtual] |
Set the output array name. If no output array name is set then the name 'BFS' is used.
| virtual void vtkPBGLBreadthFirstSearch::SetOriginFromSelection | ( | bool | ) | [virtual] |
Use the vtkSelection 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(...)).
| virtual bool vtkPBGLBreadthFirstSearch::GetOriginFromSelection | ( | ) | [virtual] |
Use the vtkSelection 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(...)).
| virtual void vtkPBGLBreadthFirstSearch::OriginFromSelectionOn | ( | ) | [virtual] |
Use the vtkSelection 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(...)).
| virtual void vtkPBGLBreadthFirstSearch::OriginFromSelectionOff | ( | ) | [virtual] |
Use the vtkSelection 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(...)).
| virtual bool vtkPBGLBreadthFirstSearch::GetOutputSelection | ( | ) | [virtual] |
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.
| virtual void vtkPBGLBreadthFirstSearch::SetOutputSelection | ( | bool | ) | [virtual] |
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.
| virtual void vtkPBGLBreadthFirstSearch::OutputSelectionOn | ( | ) | [virtual] |
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.
| virtual void vtkPBGLBreadthFirstSearch::OutputSelectionOff | ( | ) | [virtual] |
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.
| virtual void vtkPBGLBreadthFirstSearch::SetOutputSelectionType | ( | const char * | ) | [virtual] |
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
| virtual int vtkPBGLBreadthFirstSearch::RequestData | ( | vtkInformation * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkGraphAlgorithm.
| virtual int vtkPBGLBreadthFirstSearch::FillInputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
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.
Reimplemented from vtkGraphAlgorithm.
| virtual int vtkPBGLBreadthFirstSearch::FillOutputPortInformation | ( | int | port, |
| vtkInformation * | info | ||
| ) | [protected, virtual] |
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.
Reimplemented from vtkGraphAlgorithm.
The documentation for this class was generated from the following file:
- dox/Infovis/Parallel/vtkPBGLBreadthFirstSearch.h
