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
vtkBoostBreadthFirstSearch Class Reference

Boost breadth_first_search on a vtkGraph. More...

#include <vtkBoostBreadthFirstSearch.h>

Inherits vtkGraphAlgorithm.

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkBoostBreadthFirstSearchNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetOriginVertex (vtkIdType index)
 
void SetOriginVertex (vtkStdString arrayName, vtkVariant value)
 
void SetOriginVertexString (char *arrayName, char *value)
 
void SetOriginSelection (vtkSelection *s)
 
void SetOriginSelectionConnection (vtkAlgorithmOutput *algOutput)
 
virtual void SetOutputArrayName (const char *)
 
virtual void SetOriginFromSelection (bool)
 
virtual bool GetOriginFromSelection ()
 
virtual void OriginFromSelectionOn ()
 
virtual void OriginFromSelectionOff ()
 
virtual bool GetOutputSelection ()
 
virtual void SetOutputSelection (bool)
 
virtual void OutputSelectionOn ()
 
virtual void OutputSelectionOff ()
 
virtual void SetOutputSelectionType (const char *)
 

Static Public Member Functions

static vtkBoostBreadthFirstSearchNew ()
 
static int IsTypeOf (const char *type)
 
static vtkBoostBreadthFirstSearchSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

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

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
Examples:
vtkBoostBreadthFirstSearch (Examples)
Tests:
vtkBoostBreadthFirstSearch (Tests)

Definition at line 50 of file vtkBoostBreadthFirstSearch.h.

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkBoostBreadthFirstSearch::Superclass

Definition at line 54 of file vtkBoostBreadthFirstSearch.h.

Constructor & Destructor Documentation

vtkBoostBreadthFirstSearch::vtkBoostBreadthFirstSearch ( )
protected
vtkBoostBreadthFirstSearch::~vtkBoostBreadthFirstSearch ( )
protected

Member Function Documentation

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

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