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

Breadth-first search on a distributed vtkGraph. More...

#include <vtkPBGLBreadthFirstSearch.h>

Inherits vtkGraphAlgorithm.

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPBGLBreadthFirstSearchNewInstance () 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 vtkPBGLBreadthFirstSearchNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPBGLBreadthFirstSearchSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

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

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

Definition at line 51 of file vtkPBGLBreadthFirstSearch.h.

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkPBGLBreadthFirstSearch::Superclass

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
static int vtkPBGLBreadthFirstSearch::IsTypeOf ( const char *  type)
static
virtual int vtkPBGLBreadthFirstSearch::IsA ( const char *  type)
virtual
static vtkPBGLBreadthFirstSearch* vtkPBGLBreadthFirstSearch::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkPBGLBreadthFirstSearch::NewInstanceInternal ( ) const
protectedvirtual
vtkPBGLBreadthFirstSearch* vtkPBGLBreadthFirstSearch::NewInstance ( ) const
void vtkPBGLBreadthFirstSearch::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkPBGLBreadthFirstSearch::SetOriginSelection ( vtkSelection *  s)

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 *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkPBGLBreadthFirstSearch::FillInputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual
virtual int vtkPBGLBreadthFirstSearch::FillOutputPortInformation ( int  port,
vtkInformation *  info 
)
protectedvirtual

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