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

abstract class specifies interface for visualization filters More...

#include <vtkProcessObject.h>

Inheritance diagram for vtkProcessObject:
[legend]
Collaboration diagram for vtkProcessObject:
[legend]

Public Types

typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
 
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
 
vtkExecutive * GetExecutive ()
 
virtual void SetExecutive (vtkExecutive *executive)
 
virtual int ModifyRequest (vtkInformation *request, int when)
 
vtkInformationGetInputPortInformation (int port)
 
vtkInformationGetOutputPortInformation (int port)
 
int GetNumberOfInputPorts ()
 
int GetNumberOfOutputPorts ()
 
void UpdateProgress (double amount)
 
vtkInformationGetInputArrayInformation (int idx)
 
void RemoveAllInputs ()
 
vtkDataObjectGetOutputDataObject (int port)
 
int GetNumberOfInputConnections (int port)
 
int GetTotalNumberOfInputConnections ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
virtual void Update ()
 
virtual void UpdateInformation ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
 
virtual vtkInformationGetInformation ()
 
virtual void SetInformation (vtkInformation *)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
virtual void SetAbortExecute (int)
 
virtual int GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual void SetProgress (double)
 
virtual double GetProgress ()
 
void SetProgressText (const char *ptext)
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 
vtkDataObjectGetInputDataObject (int port, int connection)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
virtual void SetReleaseDataFlag (int)
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkDataObject *output)
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkProcessObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObject *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
 
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
 
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyPRESERVES_DATASET ()
 
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
 
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKeyPRESERVES_RANGES ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

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 Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm ()
 
virtual void SetNumberOfInputPorts (int n)
 
virtual void SetNumberOfOutputPorts (int n)
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 
virtual vtkExecutive * CreateDefaultExecutive ()
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 
virtual void SetErrorCode (unsigned long)
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfInputs
 
int NumberOfRequiredInputs
 
vtkDataObject ** Inputs
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
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)
 
 vtkProcessObject ()
 
 ~vtkProcessObject ()
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
int AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive * DefaultExecutivePrototype
 

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.

Member Typedef Documentation

Definition at line 54 of file vtkProcessObject.h.

Constructor & Destructor Documentation

vtkProcessObject::vtkProcessObject ( )
protected

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

vtkProcessObject::~vtkProcessObject ( )
protected

Reimplemented from vtkAlgorithm to maintain backward compatibility for vtkProcessObject.

Member Function Documentation

virtual const char* vtkProcessObject::GetClassName ( )
virtual

Reimplemented from vtkAlgorithm.

static int vtkProcessObject::IsTypeOf ( const char *  type)
static
virtual int vtkProcessObject::IsA ( const char *  name)
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkAlgorithm.

static vtkProcessObject* vtkProcessObject::SafeDownCast ( vtkObject o)
static
void vtkProcessObject::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.

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.

virtual void vtkProcessObject::SetInputConnection ( vtkAlgorithmOutput input)
inlinevirtual

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)
inlinevirtual

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 
)
protectedvirtual
virtual void vtkProcessObject::AddInput ( vtkDataObject input)
protectedvirtual
virtual void vtkProcessObject::RemoveInput ( vtkDataObject input)
protectedvirtual
virtual void vtkProcessObject::ReportReferences ( vtkGarbageCollector )
protectedvirtual

Reimplemented from vtkAlgorithm.

virtual int vtkProcessObject::FillInputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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.

virtual int vtkProcessObject::FillOutputPortInformation ( int  port,
vtkInformation info 
)
protectedvirtual

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.

void vtkProcessObject::AddInputInternal ( vtkDataObject input)
protected
void vtkProcessObject::RemoveInputInternal ( vtkDataObject input)
protected
void vtkProcessObject::SetupInputs ( )
protected

Member Data Documentation

int vtkProcessObject::NumberOfInputs
protected

Definition at line 91 of file vtkProcessObject.h.

int vtkProcessObject::NumberOfRequiredInputs
protected

Definition at line 92 of file vtkProcessObject.h.

vtkDataObject** vtkProcessObject::Inputs
protected

Definition at line 93 of file vtkProcessObject.h.


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