vtkStructuredGridAlgorithm Class Reference
#include <vtkStructuredGridAlgorithm.h>
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. 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 StructuredGrid. 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 45 of file vtkStructuredGridAlgorithm.h.
Member Typedef Documentation
Reimplemented from vtkAlgorithm.
Reimplemented in vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
Definition at line 49 of file vtkStructuredGridAlgorithm.h.
Constructor & Destructor Documentation
| vtkStructuredGridAlgorithm::vtkStructuredGridAlgorithm | ( | ) | [protected] |
| vtkStructuredGridAlgorithm::~vtkStructuredGridAlgorithm | ( | ) | [protected] |
Member Function Documentation
| static vtkStructuredGridAlgorithm* vtkStructuredGridAlgorithm::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkAlgorithm.
Reimplemented in vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| virtual const char* vtkStructuredGridAlgorithm::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| 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 vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| 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 vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| static vtkStructuredGridAlgorithm* vtkStructuredGridAlgorithm::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkAlgorithm.
Reimplemented in vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| 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 vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| vtkStructuredGrid* vtkStructuredGridAlgorithm::GetOutput | ( | ) |
Get the output data object for a port on this algorithm.
| vtkStructuredGrid* vtkStructuredGridAlgorithm::GetOutput | ( | int | ) |
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.
| virtual int vtkStructuredGridAlgorithm::ProcessRequest | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [virtual] |
see vtkAlgorithm for details
Reimplemented from vtkAlgorithm.
| vtkDataObject* vtkStructuredGridAlgorithm::GetInput | ( | ) |
| vtkDataObject* vtkStructuredGridAlgorithm::GetInput | ( | int | port | ) |
| vtkStructuredGrid* vtkStructuredGridAlgorithm::GetStructuredGridInput | ( | int | port | ) |
| void vtkStructuredGridAlgorithm::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 vtkStructuredGridAlgorithm::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 vtkStructuredGridAlgorithm::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 vtkStructuredGridAlgorithm::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 vtkStructuredGridAlgorithm::RequestInformation | ( | vtkInformation * | request, | |
| vtkInformationVector ** | inputVector, | |||
| vtkInformationVector * | outputVector | |||
| ) | [protected, virtual] |
Reimplemented in vtkExtractGrid, vtkStructuredGridClip, vtkStructuredGridLIC2D, vtkPOPReader, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| 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 vtkBlankStructuredGrid, vtkBlankStructuredGridWithImage, vtkExtractGrid, vtkStructuredGridClip, vtkTableToStructuredGrid, vtkStructuredGridLIC2D, vtkPOPReader, vtkPTableToStructuredGrid, vtkTransmitStructuredGridPiece, and vtkWindBladeReader.
| virtual int vtkStructuredGridAlgorithm::RequestUpdateExtent | ( | vtkInformation * | , | |
| vtkInformationVector ** | , | |||
| vtkInformationVector * | ||||
| ) | [inline, protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented in vtkExtractGrid, vtkStructuredGridLIC2D, and vtkTransmitStructuredGridPiece.
Definition at line 113 of file vtkStructuredGridAlgorithm.h.
| virtual void vtkStructuredGridAlgorithm::ExecuteData | ( | vtkDataObject * | output | ) | [protected, virtual] |
This method is the old style execute method
| virtual void vtkStructuredGridAlgorithm::Execute | ( | ) | [protected, virtual] |
This method is the old style execute method
| 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 vtkStructuredGridLIC2D, and vtkWindBladeReader.
| 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 vtkBlankStructuredGridWithImage, vtkTableToStructuredGrid, and vtkStructuredGridLIC2D.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkStructuredGridAlgorithm.h
