VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGenericDataSetAlgorithm Class Referenceabstract

Objects that generate adapted data sets. More...

#include <vtkGenericDataSetAlgorithm.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)
 
vtkGenericDataSet * GetGenericDataSetInput (int port)
 
vtkGenericDataSet * GetOutput ()
 
vtkGenericDataSet * 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 int IsTypeOf (const char *type)
 
static vtkGenericDataSetAlgorithmSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkGenericDataSetAlgorithm ()
 
 ~vtkGenericDataSetAlgorithm ()
 
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 RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)=0
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual void ExecuteData (vtkDataObject *output)
 
virtual void Execute ()
 

Detailed Description

Objects that generate adapted data sets.

vtkGenericDataSetAlgorithm 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 GenericDataSet. 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 vtkGenericDataSetAlgorithm.h.

Member Typedef Documentation

Definition at line 48 of file vtkGenericDataSetAlgorithm.h.

Constructor & Destructor Documentation

vtkGenericDataSetAlgorithm::vtkGenericDataSetAlgorithm ( )
protected
vtkGenericDataSetAlgorithm::~vtkGenericDataSetAlgorithm ( )
protected

Member Function Documentation

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

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

vtkGenericDataSet* vtkGenericDataSetAlgorithm::GetOutput ( int  )

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

virtual void vtkGenericDataSetAlgorithm::SetOutput ( vtkDataObject d)
virtual

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

virtual int vtkGenericDataSetAlgorithm::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
virtual

see vtkAlgorithm for details

vtkDataObject* vtkGenericDataSetAlgorithm::GetInput ( )
vtkDataObject* vtkGenericDataSetAlgorithm::GetInput ( int  port)
vtkGenericDataSet* vtkGenericDataSetAlgorithm::GetGenericDataSetInput ( int  port)
void vtkGenericDataSetAlgorithm::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 vtkGenericDataSetAlgorithm::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 vtkGenericDataSetAlgorithm::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 vtkGenericDataSetAlgorithm::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 vtkGenericDataSetAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual
virtual int vtkGenericDataSetAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override. See ProcessRequest for details about arguments and return value.

virtual int vtkGenericDataSetAlgorithm::RequestDataObject ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedpure virtual

This is called by the superclass. This is the method you should override. See ProcessRequest for details about arguments and return value.

virtual int vtkGenericDataSetAlgorithm::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
protectedvirtual

This is called by the superclass. This is the method you should override. See ProcessRequest for details about arguments and return value.

virtual void vtkGenericDataSetAlgorithm::ExecuteData ( vtkDataObject output)
protectedvirtual

This method is the old style execute method

virtual void vtkGenericDataSetAlgorithm::Execute ( )
protectedvirtual

This method is the old style execute method

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

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