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

Superclass for algorithms that produce only data object as output. More...

#include <vtkDataObjectAlgorithm.h>

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

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkDataObjectAlgorithmNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkDataObjectGetOutput ()
vtkDataObjectGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInputData (vtkDataObject *)
void SetInputData (int, vtkDataObject *)
void AddInputData (vtkDataObject *)
void AddInputData (int, vtkDataObject *)

Static Public Member Functions

static vtkDataObjectAlgorithmNew ()
static int IsTypeOf (const char *type)
static vtkDataObjectAlgorithmSafeDownCast (vtkObjectBase *o)

Protected Member Functions

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

Detailed Description

Superclass for algorithms that produce only data object as output.

vtkDataObjectAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline architecture. 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 classes constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be DataObject. 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).

Definition at line 42 of file vtkDataObjectAlgorithm.h.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

static int vtkDataObjectAlgorithm::IsTypeOf ( const char *  name) [static]
virtual int vtkDataObjectAlgorithm::IsA ( const char *  name) [virtual]
virtual vtkObjectBase* vtkDataObjectAlgorithm::NewInstanceInternal ( ) const [protected, virtual]
void vtkDataObjectAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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

Reimplemented in vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, and vtkReebGraphSurfaceSkeletonFilter.

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

virtual void vtkDataObjectAlgorithm::SetOutput ( vtkDataObject d) [virtual]

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.

Reimplemented in vtkXdmfWriter.

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

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

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

virtual int vtkDataObjectAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]
virtual int vtkDataObjectAlgorithm::RequestDataObject ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [inline, protected, virtual]
virtual int vtkDataObjectAlgorithm::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [inline, protected, virtual]

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

Reimplemented in vtkDistributedDataFilter, vtkXdmfWriter, vtkDataSetToDataObjectFilter, and vtkDataObjectGenerator.

Definition at line 107 of file vtkDataObjectAlgorithm.h.

virtual int vtkDataObjectAlgorithm::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [inline, protected, virtual]
virtual int vtkDataObjectAlgorithm::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 vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkStringToCategory, and vtkImageDataToUniformGrid.

virtual int vtkDataObjectAlgorithm::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 vtkDistributedDataFilter, vtkXdmfWriter, vtkDataSetToDataObjectFilter, vtkReflectionFilter, vtkReebGraphVolumeSkeletonFilter, vtkVolumeContourSpectrumFilter, vtkAreaContourSpectrumFilter, vtkReebGraphSurfaceSkeletonFilter, vtkExtractSelection, vtkImageDataToUniformGrid, vtkExtractSelectionBase, vtkExtractSelectedIds, and vtkExtractSelectedBlock.


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