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

Superclass for algorithms that produce only structured grid as output. More...

#include <vtkStructuredGridAlgorithm.h>

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

List of all members.

Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkStructuredGridAlgorithmNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkStructuredGridGetStructuredGridInput (int port)
vtkStructuredGridGetOutput ()
vtkStructuredGridGetOutput (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 vtkStructuredGridAlgorithmNew ()
static int IsTypeOf (const char *type)
static vtkStructuredGridAlgorithmSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkStructuredGridAlgorithm ()
 ~vtkStructuredGridAlgorithm ()
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 structured grid as output.

vtkStructuredGridAlgorithm 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 StructuredGrid. If that isn't the case then please override this method in your subclass.

Definition at line 40 of file vtkStructuredGridAlgorithm.h.


Member Typedef Documentation


Constructor & Destructor Documentation


Member Function Documentation

static int vtkStructuredGridAlgorithm::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 vtkStructuredGridLIC2D, vtkExtractGrid, vtkWindBladeReader, vtkRectilinearGridToPointSet, vtkImageDataToPointSet, vtkBlankStructuredGridWithImage, vtkBlankStructuredGrid, vtkPWindBladeReader, vtkImageToStructuredGrid, vtkStructuredGridClip, vtkTransmitStructuredGridPiece, vtkTableToStructuredGrid, and vtkPTableToStructuredGrid.

virtual int vtkStructuredGridAlgorithm::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 vtkStructuredGridLIC2D, vtkExtractGrid, vtkWindBladeReader, vtkRectilinearGridToPointSet, vtkImageDataToPointSet, vtkBlankStructuredGridWithImage, vtkBlankStructuredGrid, vtkPWindBladeReader, vtkImageToStructuredGrid, vtkStructuredGridClip, vtkTransmitStructuredGridPiece, vtkTableToStructuredGrid, and vtkPTableToStructuredGrid.

virtual vtkObjectBase* vtkStructuredGridAlgorithm::NewInstanceInternal ( ) const [protected, virtual]
void vtkStructuredGridAlgorithm::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 vtkStructuredGridLIC2D, vtkExtractGrid, vtkWindBladeReader, vtkRectilinearGridToPointSet, vtkImageDataToPointSet, vtkBlankStructuredGridWithImage, vtkPWindBladeReader, vtkBlankStructuredGrid, vtkImageToStructuredGrid, vtkStructuredGridClip, vtkTransmitStructuredGridPiece, vtkTableToStructuredGrid, and vtkPTableToStructuredGrid.

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

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

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

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

see vtkAlgorithm for details

Reimplemented from vtkAlgorithm.

Reimplemented in vtkWindBladeReader.

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

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

Reimplemented in vtkStructuredGridLIC2D, vtkExtractGrid, and vtkTransmitStructuredGridPiece.

Definition at line 103 of file vtkStructuredGridAlgorithm.h.

virtual int vtkStructuredGridAlgorithm::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 vtkWindBladeReader, vtkStructuredGridLIC2D, and vtkImageToStructuredGrid.

virtual int vtkStructuredGridAlgorithm::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 vtkStructuredGridLIC2D, vtkTableToStructuredGrid, vtkRectilinearGridToPointSet, vtkImageToStructuredGrid, vtkBlankStructuredGridWithImage, and vtkImageDataToPointSet.


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