VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkDataSetAlgorithm Class Reference

Superclass for algorithms that produce output of the same type as input. More...

#include <vtkDataSetAlgorithm.h>

Inherits vtkAlgorithm.

Public Types

typedef vtkAlgorithm Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkPolyDataGetPolyDataOutput ()
 
vtkStructuredPointsGetStructuredPointsOutput ()
 
vtkImageDataGetImageDataOutput ()
 
vtkStructuredGridGetStructuredGridOutput ()
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 
vtkRectilinearGridGetRectilinearGridOutput ()
 
vtkDataSetGetOutput ()
 
vtkDataSetGetOutput (int)
 
void SetInput (vtkDataObject *)
 
void SetInput (int, vtkDataObject *)
 
void SetInput (vtkDataSet *)
 
void SetInput (int, vtkDataSet *)
 
void AddInput (vtkDataObject *)
 
void AddInput (vtkDataSet *)
 
void AddInput (int, vtkDataSet *)
 
void AddInput (int, vtkDataObject *)
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Static Public Member Functions

static vtkDataSetAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObject *o)
 

Protected Member Functions

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

Detailed Description

Superclass for algorithms that produce output of the same type as input.

vtkDataSetAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline architecture. Ther 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 contstructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be DataSet. If that isn't the case then please override this method in your subclass. This class breaks out the downstream requests into seperate functions such as RequestDataObject RequestData and RequestInformation. The default implementation of RequestDataObject will create an output data of the same type as the input.

Tests:
vtkDataSetAlgorithm (Tests)

Definition at line 49 of file vtkDataSetAlgorithm.h.

Member Typedef Documentation

typedef vtkAlgorithm vtkDataSetAlgorithm::Superclass

Definition at line 53 of file vtkDataSetAlgorithm.h.

Constructor & Destructor Documentation

vtkDataSetAlgorithm::vtkDataSetAlgorithm ( )
protected
vtkDataSetAlgorithm::~vtkDataSetAlgorithm ( )
inlineprotected

Definition at line 118 of file vtkDataSetAlgorithm.h.

Member Function Documentation

static vtkDataSetAlgorithm* vtkDataSetAlgorithm::New ( )
static
virtual const char* vtkDataSetAlgorithm::GetClassName ( )
virtual
static int vtkDataSetAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkDataSetAlgorithm::IsA ( const char *  type)
virtual
static vtkDataSetAlgorithm* vtkDataSetAlgorithm::SafeDownCast ( vtkObject o)
static
void vtkDataSetAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
vtkDataSet* vtkDataSetAlgorithm::GetOutput ( )

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

vtkDataSet* vtkDataSetAlgorithm::GetOutput ( int  )

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

vtkDataObject* vtkDataSetAlgorithm::GetInput ( )

Get the input data object. This method is not recommended for use, but lots of old style filters use it.

vtkPolyData* vtkDataSetAlgorithm::GetPolyDataOutput ( )

Get the output as vtkPolyData.

vtkStructuredPoints* vtkDataSetAlgorithm::GetStructuredPointsOutput ( )

Get the output as vtkStructuredPoints.

vtkImageData* vtkDataSetAlgorithm::GetImageDataOutput ( )

Get the output as vtkStructuredPoints.

vtkStructuredGrid* vtkDataSetAlgorithm::GetStructuredGridOutput ( )

Get the output as vtkStructuredGrid.

vtkUnstructuredGrid* vtkDataSetAlgorithm::GetUnstructuredGridOutput ( )

Get the output as vtkUnstructuredGrid.

vtkRectilinearGrid* vtkDataSetAlgorithm::GetRectilinearGridOutput ( )

Get the output as vtkRectilinearGrid.

void vtkDataSetAlgorithm::SetInput ( vtkDataObject )

Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.

void vtkDataSetAlgorithm::SetInput ( int  ,
vtkDataObject  
)

Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.

void vtkDataSetAlgorithm::SetInput ( vtkDataSet )

Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.

void vtkDataSetAlgorithm::SetInput ( int  ,
vtkDataSet  
)

Set an input of this algorithm. You should not override these methods because they are not the only way to connect a pipeline. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::SetInputConnection(). These methods transform the input index to the input port index, not an index of a connection within a single port.

void vtkDataSetAlgorithm::AddInput ( vtkDataObject )

Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.

void vtkDataSetAlgorithm::AddInput ( vtkDataSet )

Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.

void vtkDataSetAlgorithm::AddInput ( int  ,
vtkDataSet  
)

Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.

void vtkDataSetAlgorithm::AddInput ( int  ,
vtkDataObject  
)

Add an input of this algorithm. Note that these methods support old-style pipeline connections. When writing new code you should use the more general vtkAlgorithm::AddInputConnection(). See SetInput() for details.

virtual int vtkDataSetAlgorithm::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
virtual

see vtkAlgorithm for details

virtual int vtkDataSetAlgorithm::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineprotectedvirtual

This is called within ProcessRequest when a request asks for Information. Typically an algorithm provides whatever lightweight information about its output that it can here without doing any lengthy computations. This happens in the first pass of the pipeline execution.

Definition at line 126 of file vtkDataSetAlgorithm.h.

virtual int vtkDataSetAlgorithm::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineprotectedvirtual

This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. This happens during the second pass in the pipeline execution process.

Definition at line 136 of file vtkDataSetAlgorithm.h.

virtual int vtkDataSetAlgorithm::RequestDataObject ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. This typically happens early on in the execution of the pipeline. The default behavior is to create an output DataSet of the same type as the input for each output port. This method can be overridden to change the output data type of an algorithm. This happens in the third pass of the pipeline execution.

virtual int vtkDataSetAlgorithm::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
inlineprotectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work. This is the method you should override to do whatever the algorithm is designed to do. This happens during the fourth pass in the pipeline execution process.

Definition at line 163 of file vtkDataSetAlgorithm.h.

virtual int vtkDataSetAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual
virtual int vtkDataSetAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual
vtkDataObject* vtkDataSetAlgorithm::GetInput ( int  port)
protected

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