vtkBoostBreadthFirstSearchTree Class Reference

#include <vtkBoostBreadthFirstSearchTree.h>

Inheritance diagram for vtkBoostBreadthFirstSearchTree:

[legend]

Collaboration diagram for vtkBoostBreadthFirstSearchTree:

[legend]

List of all members.

---

Detailed Description

Contructs a BFS tree from a graph.

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). The result is a tree with root node corresponding to the start node of the search.

See also:

vtkGraph vtkBoostGraphAdapter

Examples:

vtkBoostBreadthFirstSearchTree (Examples)

Tests:

vtkBoostBreadthFirstSearchTree (Tests)

Definition at line 49 of file vtkBoostBreadthFirstSearchTree.h.

Public Types
typedef vtkTreeAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetOriginVertex (vtkIdType index)
void	SetOriginVertex (vtkStdString arrayName, vtkVariant value)
virtual void	SetCreateGraphVertexIdArray (bool)
virtual bool	GetCreateGraphVertexIdArray ()
virtual void	CreateGraphVertexIdArrayOn ()
virtual void	CreateGraphVertexIdArrayOff ()
virtual void	SetReverseEdges (bool)
virtual bool	GetReverseEdges ()
virtual void	ReverseEdgesOn ()
virtual void	ReverseEdgesOff ()
Static Public Member Functions
static vtkBoostBreadthFirstSearchTree *	New ()
static int	IsTypeOf (const char *type)
static vtkBoostBreadthFirstSearchTree *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkBoostBreadthFirstSearchTree ()
	~vtkBoostBreadthFirstSearchTree ()
int	FillInputPortInformation (int port, vtkInformation *info)
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

---

Member Typedef Documentation

typedef vtkTreeAlgorithm vtkBoostBreadthFirstSearchTree::Superclass

Reimplemented from vtkTreeAlgorithm.

Definition at line 53 of file vtkBoostBreadthFirstSearchTree.h.

---

Constructor & Destructor Documentation

vtkBoostBreadthFirstSearchTree::vtkBoostBreadthFirstSearchTree

(

)

[protected]

vtkBoostBreadthFirstSearchTree::~vtkBoostBreadthFirstSearchTree

(

)

[protected]

---

Member Function Documentation

static vtkBoostBreadthFirstSearchTree* vtkBoostBreadthFirstSearchTree::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkTreeAlgorithm.

virtual const char* vtkBoostBreadthFirstSearchTree::GetClassName

(

)

[virtual]

Reimplemented from vtkTreeAlgorithm.

static int vtkBoostBreadthFirstSearchTree::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 vtkTreeAlgorithm.

virtual int vtkBoostBreadthFirstSearchTree::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 vtkTreeAlgorithm.

static vtkBoostBreadthFirstSearchTree* vtkBoostBreadthFirstSearchTree::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkTreeAlgorithm.

void vtkBoostBreadthFirstSearchTree::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 vtkTreeAlgorithm.

void vtkBoostBreadthFirstSearchTree::SetOriginVertex

(

vtkIdType

index

)

Set the index (into the vertex array) of the breadth first search 'origin' vertex.

void vtkBoostBreadthFirstSearchTree::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.

virtual void vtkBoostBreadthFirstSearchTree::SetCreateGraphVertexIdArray

(

bool

)

[virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual bool vtkBoostBreadthFirstSearchTree::GetCreateGraphVertexIdArray

(

)

[virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual void vtkBoostBreadthFirstSearchTree::CreateGraphVertexIdArrayOn

(

)

[virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual void vtkBoostBreadthFirstSearchTree::CreateGraphVertexIdArrayOff

(

)

[virtual]

Stores the graph vertex ids for the tree vertices in an array named "GraphVertexId". Default is off.

virtual void vtkBoostBreadthFirstSearchTree::SetReverseEdges

(

bool

)

[virtual]

Turn on this option to reverse the edges in the graph.

virtual bool vtkBoostBreadthFirstSearchTree::GetReverseEdges

(

)

[virtual]

Turn on this option to reverse the edges in the graph.

virtual void vtkBoostBreadthFirstSearchTree::ReverseEdgesOn

(

)

[virtual]

Turn on this option to reverse the edges in the graph.

virtual void vtkBoostBreadthFirstSearchTree::ReverseEdgesOff

(

)

[virtual]

Turn on this option to reverse the edges in the graph.

int vtkBoostBreadthFirstSearchTree::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 vtkTreeAlgorithm.

int vtkBoostBreadthFirstSearchTree::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			[protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTreeAlgorithm.

---

The documentation for this class was generated from the following file:

• dox/Infovis/vtkBoostBreadthFirstSearchTree.h