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

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

#include <vtkStructuredGridAlgorithm.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 ()
 
vtkDataObjectGetInput (int port)
 
vtkStructuredGrid * GetStructuredGridInput (int port)
 
vtkStructuredGrid * GetOutput ()
 
vtkStructuredGrid * GetOutput (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 vtkStructuredGridAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkStructuredGridAlgorithmSafeDownCast (vtkObject *o)
 

Protected Member Functions

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

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

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
virtual const char* vtkStructuredGridAlgorithm::GetClassName ( )
virtual
static int vtkStructuredGridAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkStructuredGridAlgorithm::IsA ( const char *  type)
virtual
static vtkStructuredGridAlgorithm* vtkStructuredGridAlgorithm::SafeDownCast ( vtkObject o)
static
void vtkStructuredGridAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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

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

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

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

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

Definition at line 113 of file vtkStructuredGridAlgorithm.h.

virtual void vtkStructuredGridAlgorithm::ExecuteData ( vtkDataObject output)
protectedvirtual

This method is the old style execute method

virtual void vtkStructuredGridAlgorithm::Execute ( )
protectedvirtual

This method is the old style execute method

virtual int vtkStructuredGridAlgorithm::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual
virtual int vtkStructuredGridAlgorithm::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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