VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkBoostBreadthFirstSearchTree Class Reference

Contructs a BFS tree from a graph. More...

#include <vtkBoostBreadthFirstSearchTree.h>

Inherits vtkTreeAlgorithm.

Public Types

typedef vtkTreeAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkBoostBreadthFirstSearchTreeNewInstance () const
 
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 (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkBoostBreadthFirstSearchTree ()
 
 ~vtkBoostBreadthFirstSearchTree ()
 
int FillInputPortInformation (int port, vtkInformation *info)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

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 50 of file vtkBoostBreadthFirstSearchTree.h.

Member Typedef Documentation

Definition at line 54 of file vtkBoostBreadthFirstSearchTree.h.

Constructor & Destructor Documentation

vtkBoostBreadthFirstSearchTree::vtkBoostBreadthFirstSearchTree ( )
protected
vtkBoostBreadthFirstSearchTree::~vtkBoostBreadthFirstSearchTree ( )
protected

Member Function Documentation

static vtkBoostBreadthFirstSearchTree* vtkBoostBreadthFirstSearchTree::New ( )
static
static int vtkBoostBreadthFirstSearchTree::IsTypeOf ( const char *  type)
static
virtual int vtkBoostBreadthFirstSearchTree::IsA ( const char *  type)
virtual
static vtkBoostBreadthFirstSearchTree* vtkBoostBreadthFirstSearchTree::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkBoostBreadthFirstSearchTree::NewInstanceInternal ( ) const
protectedvirtual
vtkBoostBreadthFirstSearchTree* vtkBoostBreadthFirstSearchTree::NewInstance ( ) const
void vtkBoostBreadthFirstSearchTree::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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
int vtkBoostBreadthFirstSearchTree::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

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