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

Superclass for algorithms that produce only Selection as output. More...

#include <vtkSelectionAlgorithm.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)
 
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
vtkSelectionGetOutput ()
 
vtkSelectionGetOutput (int index)
 
void SetInput (vtkDataObject *obj)
 
void SetInput (int index, vtkDataObject *obj)
 

Static Public Member Functions

static vtkSelectionAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSelectionAlgorithmSafeDownCast (vtkObject *o)
 

Protected Member Functions

 vtkSelectionAlgorithm ()
 
 ~vtkSelectionAlgorithm ()
 
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 Selection as output.

vtkSelectionAlgorithm is a convenience class to make writing algorithms easier. It is also designed to help transition old algorithms to the new pipeline edgehitecture. 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 class constructor for the default. This class also provides a FillInputPortInfo method that by default says that all inputs will be Selection. If that isn't the case then please override this method in your subclass. This class breaks out the downstream requests into separate 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.

Thanks:
Thanks to Patricia Crossno, Ken Moreland, Andrew Wilson and Brian Wylie from Sandia National Laboratories for their help in developing this class.
Tests:
vtkSelectionAlgorithm (Tests)

Definition at line 51 of file vtkSelectionAlgorithm.h.

Member Typedef Documentation

typedef vtkAlgorithm vtkSelectionAlgorithm::Superclass

Definition at line 55 of file vtkSelectionAlgorithm.h.

Constructor & Destructor Documentation

vtkSelectionAlgorithm::vtkSelectionAlgorithm ( )
protected
vtkSelectionAlgorithm::~vtkSelectionAlgorithm ( )
protected

Member Function Documentation

static vtkSelectionAlgorithm* vtkSelectionAlgorithm::New ( )
static
virtual const char* vtkSelectionAlgorithm::GetClassName ( )
virtual
static int vtkSelectionAlgorithm::IsTypeOf ( const char *  type)
static
virtual int vtkSelectionAlgorithm::IsA ( const char *  type)
virtual
static vtkSelectionAlgorithm* vtkSelectionAlgorithm::SafeDownCast ( vtkObject o)
static
void vtkSelectionAlgorithm::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual int vtkSelectionAlgorithm::ProcessRequest ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
virtual

see vtkAlgorithm for details

vtkSelection* vtkSelectionAlgorithm::GetOutput ( )
inline

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

Definition at line 67 of file vtkSelectionAlgorithm.h.

vtkSelection* vtkSelectionAlgorithm::GetOutput ( int  index)

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

void vtkSelectionAlgorithm::SetInput ( vtkDataObject obj)
inline

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.

Definition at line 79 of file vtkSelectionAlgorithm.h.

void vtkSelectionAlgorithm::SetInput ( int  index,
vtkDataObject obj 
)

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.

virtual int vtkSelectionAlgorithm::RequestInformation ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual
virtual int vtkSelectionAlgorithm::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

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

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

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

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

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