vtkProcessObject Class Reference

#include <vtkProcessObject.h>

Inheritance diagram for vtkProcessObject:

Inheritance graph
[legend]
Collaboration diagram for vtkProcessObject:

Collaboration graph
[legend]

List of all members.


Detailed Description

abstract class specifies interface for visualization filters

vtkProcessObject is an abstract object that specifies behavior and interface of visualization network process objects (sources, filters, mappers). Source objects are creators of visualization data; filters input, process, and output visualization data; and mappers transform data into another form (like rendering primitives or write data to a file).

vtkProcessObject fires events for Start and End events before and after object execution (via Execute()). These events can be used for any purpose (e.g., debugging info, highlighting/notifying user interface, etc.)

Another event, Progress, can be observed. Some filters fire this event periodically during their execution. The use is similar to that of Start and End events. Filters may also check their AbortExecute flag to determine whether to prematurely end their execution.

An important feature of subclasses of vtkProcessObject is that it is possible to control the memory-management model (i.e., retain output versus delete output data). If enabled the ReleaseDataFlag enables the deletion of the output data once the downstream process object finishes processing the data (please see text).

See also:
vtkDataObject vtkSource vtkFilter vtkMapper vtkWriter

Definition at line 51 of file vtkProcessObject.h.


Public Types

typedef vtkAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SqueezeInputArray ()
void RemoveAllInputs ()
vtkDataObject ** GetInputs ()
int GetNumberOfInputs ()
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetNumberOfInputConnections (int port, int n)

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkProcessObjectSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkProcessObject ()
 ~vtkProcessObject ()
void SetNumberOfInputs (int num)
virtual void SetNthInput (int num, vtkDataObject *input)
virtual void AddInput (vtkDataObject *input)
virtual void RemoveInput (vtkDataObject *input)
virtual void ReportReferences (vtkGarbageCollector *)
virtual int FillInputPortInformation (int, vtkInformation *)
virtual int FillOutputPortInformation (int, vtkInformation *)
void AddInputInternal (vtkDataObject *input)
void RemoveInputInternal (vtkDataObject *input)
void SetupInputs ()

Protected Attributes

int NumberOfInputs
int NumberOfRequiredInputs
vtkDataObject ** Inputs

Member Typedef Documentation


Constructor & Destructor Documentation

vtkProcessObject::vtkProcessObject (  )  [protected]

vtkProcessObject::~vtkProcessObject (  )  [protected]


Member Function Documentation

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

static int vtkProcessObject::IsTypeOf ( const char *  name  )  [static]

virtual int vtkProcessObject::IsA ( const char *  name  )  [virtual]

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

void vtkProcessObject::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

vtkDataObject** vtkProcessObject::GetInputs (  ) 

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

int vtkProcessObject::GetNumberOfInputs (  ) 

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

void vtkProcessObject::SqueezeInputArray (  ) 

This method will rearrange the input array so that all NULL entries are removed.

void vtkProcessObject::RemoveAllInputs (  ) 

Remove all the input data.

Reimplemented from vtkAlgorithm.

virtual void vtkProcessObject::SetInputConnection ( vtkAlgorithmOutput input  )  [inline, virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

Definition at line 74 of file vtkProcessObject.h.

virtual void vtkProcessObject::SetInputConnection ( int  port,
vtkAlgorithmOutput input 
) [virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

virtual void vtkProcessObject::AddInputConnection ( int  port,
vtkAlgorithmOutput input 
) [virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

virtual void vtkProcessObject::AddInputConnection ( vtkAlgorithmOutput input  )  [inline, virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

Definition at line 78 of file vtkProcessObject.h.

virtual void vtkProcessObject::RemoveInputConnection ( int  port,
vtkAlgorithmOutput input 
) [virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

virtual void vtkProcessObject::SetNthInputConnection ( int  port,
int  index,
vtkAlgorithmOutput input 
) [virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

virtual void vtkProcessObject::SetNumberOfInputConnections ( int  port,
int  n 
) [virtual]

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Reimplemented from vtkAlgorithm.

void vtkProcessObject::SetNumberOfInputs ( int  num  )  [protected]

virtual void vtkProcessObject::SetNthInput ( int  num,
vtkDataObject input 
) [protected, virtual]

virtual void vtkProcessObject::AddInput ( vtkDataObject input  )  [protected, virtual]

virtual void vtkProcessObject::RemoveInput ( vtkDataObject input  )  [protected, virtual]

virtual void vtkProcessObject::ReportReferences ( vtkGarbageCollector  )  [protected, virtual]

Reimplemented from vtkAlgorithm.

Reimplemented in vtkSource, and vtkSpatialRepresentationFilter.

virtual int vtkProcessObject::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

virtual int vtkProcessObject::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 vtkDataObjectSource, vtkDataSetSource, vtkImageSource, vtkPointSetSource, vtkPolyDataSource, vtkRectilinearGridSource, vtkSource, vtkStructuredGridSource, vtkStructuredPointsSource, and vtkUnstructuredGridSource.

void vtkProcessObject::AddInputInternal ( vtkDataObject input  )  [protected]

void vtkProcessObject::RemoveInputInternal ( vtkDataObject input  )  [protected]

void vtkProcessObject::SetupInputs (  )  [protected]


Member Data Documentation

Definition at line 91 of file vtkProcessObject.h.

Definition at line 92 of file vtkProcessObject.h.

Definition at line 93 of file vtkProcessObject.h.


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

Generated on Wed Jun 3 19:27:11 2009 for VTK by  doxygen 1.5.6