vtkBoostBreadthFirstSearch Class Reference
#include <vtkBoostBreadthFirstSearch.h>
Detailed Description
Boost breadth_first_search on a vtkGraph.This vtk class uses the Boost breadth_first_search generic algorithm to perform a breadth first search from a given a 'source' vertex on the input graph (a vtkGraph).
- See also:
- vtkGraph vtkBoostGraphAdapter
Definition at line 46 of file vtkBoostBreadthFirstSearch.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkBoostBreadthFirstSearch::vtkBoostBreadthFirstSearch | ( | ) | [protected] |
| vtkBoostBreadthFirstSearch::~vtkBoostBreadthFirstSearch | ( | ) | [protected] |
Member Function Documentation
| static vtkBoostBreadthFirstSearch* vtkBoostBreadthFirstSearch::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkGraphAlgorithm.
| virtual const char* vtkBoostBreadthFirstSearch::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkGraphAlgorithm.
| static int vtkBoostBreadthFirstSearch::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkGraphAlgorithm.
| virtual int vtkBoostBreadthFirstSearch::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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkGraphAlgorithm.
| static vtkBoostBreadthFirstSearch* vtkBoostBreadthFirstSearch::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkGraphAlgorithm.
| void vtkBoostBreadthFirstSearch::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.
| void vtkBoostBreadthFirstSearch::SetOriginSelection | ( | vtkSelection * | s | ) |
Convenience methods for setting the origin selection input.
| void vtkBoostBreadthFirstSearch::SetOriginSelectionConnection | ( | vtkAlgorithmOutput * | algOutput | ) | [inline] |
Convenience methods for setting the origin selection input.
Definition at line 56 of file vtkBoostBreadthFirstSearch.h.
| void vtkBoostBreadthFirstSearch::SetOriginVertex | ( | vtkIdType | index | ) |
Set the index (into the vertex array) of the breadth first search 'origin' vertex.
| void vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::SetOutputArrayName | ( | const char * | ) | [virtual] |
Set the output array name. If no output array name is set then the name 'BFS' is used.
| virtual void vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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 vtkBoostBreadthFirstSearch::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/vtkBoostBreadthFirstSearch.h
