vtkRectilinearGridAlgorithm Class Reference

#include <vtkRectilinearGridAlgorithm.h>

Inheritance diagram for vtkRectilinearGridAlgorithm:

[legend]Collaboration diagram for vtkRectilinearGridAlgorithm:

[legend]List of all members.

---

Detailed Description

Superclass for algorithms that produce only rectilinear grid as output.

vtkRectilinearGridAlgorithm 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 RectilinearGrid. 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 vtkRectilinearGridAlgorithm.h.

Public Types
typedef vtkAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkRectilinearGrid *	GetOutput ()
vtkRectilinearGrid *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
vtkRectilinearGrid *	GetRectilinearGridInput (int port)
void	SetInput (vtkDataObject *)
void	SetInput (int, vtkDataObject *)
void	AddInput (vtkDataObject *)
void	AddInput (int, vtkDataObject *)
Static Public Member Functions
static vtkRectilinearGridAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkRectilinearGridAlgorithm *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkRectilinearGridAlgorithm ()
	~vtkRectilinearGridAlgorithm ()
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void	ExecuteData (vtkDataObject *output)
virtual void	Execute ()

---

Member Typedef Documentation

typedef vtkAlgorithm vtkRectilinearGridAlgorithm::Superclass

Reimplemented from vtkAlgorithm. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip. Definition at line 49 of file vtkRectilinearGridAlgorithm.h.

---

Constructor & Destructor Documentation

vtkRectilinearGridAlgorithm::vtkRectilinearGridAlgorithm (   )  [protected]

vtkRectilinearGridAlgorithm::~vtkRectilinearGridAlgorithm (   )  [protected]

---

Member Function Documentation

static vtkRectilinearGridAlgorithm* vtkRectilinearGridAlgorithm::New (   )  [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkAlgorithm. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

virtual const char* vtkRectilinearGridAlgorithm::GetClassName (   )  [virtual]

Reimplemented from vtkAlgorithm. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

static int vtkRectilinearGridAlgorithm::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkAlgorithm. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

virtual int vtkRectilinearGridAlgorithm::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkAlgorithm. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

static vtkRectilinearGridAlgorithm* vtkRectilinearGridAlgorithm::SafeDownCast (  vtkObject *  o  )  [static]

Reimplemented from vtkAlgorithm. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

void vtkRectilinearGridAlgorithm::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 vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

vtkRectilinearGrid* vtkRectilinearGridAlgorithm::GetOutput (   )

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

vtkRectilinearGrid* vtkRectilinearGridAlgorithm::GetOutput (  int   )

virtual void vtkRectilinearGridAlgorithm::SetOutput (  vtkDataObject *  d  )  [virtual]

virtual int vtkRectilinearGridAlgorithm::ProcessRequest (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [virtual]

see vtkAlgorithm for details Reimplemented from vtkAlgorithm.

vtkDataObject* vtkRectilinearGridAlgorithm::GetInput (   )

vtkDataObject* vtkRectilinearGridAlgorithm::GetInput (  int  port  )

vtkRectilinearGrid* vtkRectilinearGridAlgorithm::GetRectilinearGridInput (  int  port  )

void vtkRectilinearGridAlgorithm::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 vtkRectilinearGridAlgorithm::SetInput (  int  , vtkDataObject *  )

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

Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

virtual int vtkRectilinearGridAlgorithm::RequestData (  vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector )  [protected, virtual]

This is called by the superclass. This is the method you should override. Reimplemented in vtkExtractRectilinearGrid, and vtkRectilinearGridClip.

virtual int vtkRectilinearGridAlgorithm::RequestUpdateExtent (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [inline, protected, virtual]

This is called by the superclass. This is the method you should override. Reimplemented in vtkExtractRectilinearGrid. Definition at line 113 of file vtkRectilinearGridAlgorithm.h.

virtual void vtkRectilinearGridAlgorithm::ExecuteData (  vtkDataObject *  output  )  [protected, virtual]

This method is the old style execute method

virtual void vtkRectilinearGridAlgorithm::Execute (   )  [protected, virtual]

This method is the old style execute method

virtual int vtkRectilinearGridAlgorithm::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.

virtual int vtkRectilinearGridAlgorithm::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.

---

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

• dox/Filtering/vtkRectilinearGridAlgorithm.h

---