VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkSelectionAlgorithm Class Reference

Superclass for algorithms that produce only Selection as output. More...

#include <vtkSelectionAlgorithm.h>

Inheritance diagram for vtkSelectionAlgorithm:
Inheritance graph
[legend]
Collaboration diagram for vtkSelectionAlgorithm:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkSelectionAlgorithmNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkSelectionGetOutput ()
vtkSelectionGetOutput (int index)
void SetInputData (vtkDataObject *obj)
void SetInputData (int index, vtkDataObject *obj)

Static Public Member Functions

static vtkSelectionAlgorithmNew ()
static int IsTypeOf (const char *type)
static vtkSelectionAlgorithmSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkSelectionAlgorithm ()
 ~vtkSelectionAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Detailed Description

Superclass for algorithms that produce only Selection as output.

vtkSelectionAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline edgehitecture. There are some assumptions and defaults made by this class you should be aware of. This class defaults such that your filter will have one input port and one output port. If that is not the case simply change it with SetNumberOfInputPorts etc. See this class constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be Selection. If that isn't the case then please override this method in your subclass. You should implement the subclass's algorithm into RequestData( request, inputVec, outputVec).

Thanks:
Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class.

Definition at line 45 of file vtkSelectionAlgorithm.h.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkAlgorithm.

Reimplemented in vtkComputeHistogram2DOutliers, vtkConvertSelection, vtkCellDistanceSelector, vtkPComputeHistogram2DOutliers, vtkLinearSelector, vtkExpandSelectedGraph, vtkBoostKruskalMinimumSpanningTree, vtkAppendSelection, vtkKdTreeSelector, and vtkSelectionSource.

static int vtkSelectionAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkComputeHistogram2DOutliers, vtkConvertSelection, vtkCellDistanceSelector, vtkPComputeHistogram2DOutliers, vtkExpandSelectedGraph, vtkBoostKruskalMinimumSpanningTree, vtkLinearSelector, vtkAppendSelection, vtkKdTreeSelector, and vtkSelectionSource.

virtual int vtkSelectionAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkComputeHistogram2DOutliers, vtkConvertSelection, vtkCellDistanceSelector, vtkPComputeHistogram2DOutliers, vtkExpandSelectedGraph, vtkBoostKruskalMinimumSpanningTree, vtkLinearSelector, vtkAppendSelection, vtkKdTreeSelector, and vtkSelectionSource.

virtual vtkObjectBase* vtkSelectionAlgorithm::NewInstanceInternal ( ) const [protected, virtual]
void vtkSelectionAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkComputeHistogram2DOutliers, vtkConvertSelection, vtkCellDistanceSelector, vtkPComputeHistogram2DOutliers, vtkExpandSelectedGraph, vtkBoostKruskalMinimumSpanningTree, vtkLinearSelector, vtkAppendSelection, vtkKdTreeSelector, and vtkSelectionSource.

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

Get the output data object for a port on this algorithm.

Definition at line 61 of file vtkSelectionAlgorithm.h.

Get the output data object for a port on this algorithm.

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

Definition at line 69 of file vtkSelectionAlgorithm.h.

Assign a data object as input. Note that this method does not establish a pipeline connection. Use SetInputConnection() to setup a pipeline connection.

virtual int vtkSelectionAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Reimplemented in vtkSelectionSource.

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

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

virtual int vtkSelectionAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkComputeHistogram2DOutliers, and vtkBoostKruskalMinimumSpanningTree.

virtual int vtkSelectionAlgorithm::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 vtkAlgorithm.

Reimplemented in vtkConvertSelection, vtkCellDistanceSelector, vtkComputeHistogram2DOutliers, vtkKdTreeSelector, vtkAppendSelection, vtkLinearSelector, vtkBoostKruskalMinimumSpanningTree, and vtkExpandSelectedGraph.


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