vtkUnstructuredGridAlgorithm Class Reference

#include <vtkUnstructuredGridAlgorithm.h>

Inheritance diagram for vtkUnstructuredGridAlgorithm:

Inheritance graph
[legend]
Collaboration diagram for vtkUnstructuredGridAlgorithm:

Collaboration graph
[legend]

List of all members.


Detailed Description

Superclass for algorithms that produce only unstructured grid as output.

vtkUnstructuredGridAlgorithm 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 constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be UnstructuredGrid. 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 ExecuteData and ExecuteInformation. For new algorithms you should implement RequestData( request, inputVec, outputVec) but for older filters there is a default implementation that calls the old ExecuteData(output) signature, for even older filters that don;t implement ExecuteData the default implementation calls the even older Execute() signature.

Definition at line 44 of file vtkUnstructuredGridAlgorithm.h.


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 (int port)
vtkDataObjectGetInput ()
vtkUnstructuredGridGetUnstructuredGridInput (int port)
vtkUnstructuredGridGetOutput ()
vtkUnstructuredGridGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)

Static Public Member Functions

static
vtkUnstructuredGridAlgorithm
New ()
static int IsTypeOf (const char *type)
static
vtkUnstructuredGridAlgorithm
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkUnstructuredGridAlgorithm ()
 ~vtkUnstructuredGridAlgorithm ()
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 *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()

Member Typedef Documentation


Constructor & Destructor Documentation

vtkUnstructuredGridAlgorithm::vtkUnstructuredGridAlgorithm (  )  [protected]

vtkUnstructuredGridAlgorithm::~vtkUnstructuredGridAlgorithm (  )  [protected]


Member Function Documentation

static vtkUnstructuredGridAlgorithm* vtkUnstructuredGridAlgorithm::New (  )  [static]

virtual const char* vtkUnstructuredGridAlgorithm::GetClassName (  )  [virtual]

static int vtkUnstructuredGridAlgorithm::IsTypeOf ( const char *  name  )  [static]

virtual int vtkUnstructuredGridAlgorithm::IsA ( const char *  name  )  [virtual]

static vtkUnstructuredGridAlgorithm* vtkUnstructuredGridAlgorithm::SafeDownCast ( vtkObject o  )  [static]

void vtkUnstructuredGridAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

vtkUnstructuredGrid* vtkUnstructuredGridAlgorithm::GetOutput (  ) 

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

Reimplemented in vtkMPASReader.

vtkUnstructuredGrid* vtkUnstructuredGridAlgorithm::GetOutput ( int   ) 

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

Reimplemented in vtkMPASReader.

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

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

virtual int vtkUnstructuredGridAlgorithm::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [virtual]

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

Reimplemented in vtkClipDataSet, vtkTableBasedClipDataSet, and vtkThreshold.

vtkDataObject* vtkUnstructuredGridAlgorithm::GetInput ( int  port  ) 

Reimplemented in vtkAppendFilter.

vtkDataObject* vtkUnstructuredGridAlgorithm::GetInput (  )  [inline]

Reimplemented in vtkAppendFilter.

Definition at line 68 of file vtkUnstructuredGridAlgorithm.h.

vtkUnstructuredGrid* vtkUnstructuredGridAlgorithm::GetUnstructuredGridInput ( int  port  ) 

void vtkUnstructuredGridAlgorithm::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 vtkUnstructuredGridAlgorithm::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 vtkUnstructuredGridAlgorithm::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 vtkUnstructuredGridAlgorithm::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 vtkUnstructuredGridAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

virtual int vtkUnstructuredGridAlgorithm::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

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

Reimplemented in vtkUnstructuredGridGeometryFilter, vtkExtractUnstructuredGridPiece, and vtkTransmitUnstructuredGridPiece.

virtual void vtkUnstructuredGridAlgorithm::ExecuteData ( vtkDataObject output  )  [protected, virtual]

This method is the old style execute method

virtual void vtkUnstructuredGridAlgorithm::Execute (  )  [protected, virtual]

This method is the old style execute method

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

virtual int vtkUnstructuredGridAlgorithm::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 vtkGenericClip, vtkGenericDataSetTessellator, vtkAppendFilter, vtkBoxClipDataSet, vtkClipDataSet, vtkClipHyperOctree, vtkClipVolume, vtkConnectivityFilter, vtkDataSetTriangleFilter, vtkDelaunay3D, vtkExtractCells, vtkExtractGeometry, vtkRectilinearGridToTetrahedra, vtkRotationFilter, vtkShrinkFilter, vtkTableBasedClipDataSet, vtkTessellatorFilter, vtkThreshold, and vtkUnstructuredGridGeometryFilter.


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

Generated on Wed Aug 24 12:16:08 2011 for VTK by  doxygen 1.5.6