Main Page | Directories | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

vtkExecutive Class Reference

#include <vtkExecutive.h>

Inheritance diagram for vtkExecutive:

Inheritance graph
[legend]
Collaboration diagram for vtkExecutive:

Collaboration graph
[legend]
List of all members.

Detailed Description

Superclass for all pipeline executives in VTK.

vtkExecutive is the superclass for all pipeline executives in VTK. A VTK executive is responsible for controlling one or more instances of vtkAlgorithm. A pipeline consists of one or more executives that control data flow. Every reader, source, writer, or data processing algorithm in the pipeline is implemented in an instance of vtkAlgorithm.

Created by:
  • Bertel, Francois
CVS contributions (if > 5%):
  • Bertel, Francois (80%)
  • Martin, Ken (19%)
CVS logs (CVSweb):
  • .h (/Filtering/vtkExecutive.h)
  • .cxx (/Filtering/vtkExecutive.cxx)

Definition at line 50 of file vtkExecutive.h.

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual int Update (vtkAlgorithm *algorithm)=0
virtual int Update (vtkAlgorithm *algorithm, int port)=0
virtual vtkAlgorithmOutputGetProducerPort (vtkDataObject *)=0
virtual void UnRegister (vtkObjectBase *o)
virtual vtkInformationGetOutputInformation (vtkAlgorithm *algorithm, int port)=0
virtual vtkDataObjectGetOutputData (vtkAlgorithm *algorithm, int port)=0
virtual void SetOutputData (vtkAlgorithm *algorithm, int port, vtkDataObject *)=0
virtual vtkDataObjectGetInputData (vtkAlgorithm *algorithm, int port, int connection)=0

Static Public Member Functions

int IsTypeOf (const char *type)
vtkExecutiveSafeDownCast (vtkObject *o)
vtkInformationExecutiveKeyEXECUTIVE ()
vtkInformationIntegerKeyPORT_NUMBER ()

Protected Member Functions

 vtkExecutive ()
 ~vtkExecutive ()
virtual void GarbageCollectionStarting ()
virtual void AddAlgorithm (vtkAlgorithm *algorithm)=0
virtual void RemoveAlgorithm (vtkAlgorithm *algorithm)=0

Protected Attributes

int GarbageCollecting


Member Typedef Documentation

typedef vtkObject vtkExecutive::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

Definition at line 53 of file vtkExecutive.h.


Constructor & Destructor Documentation

vtkExecutive::vtkExecutive  )  [protected]
 

vtkExecutive::~vtkExecutive  )  [protected]
 


Member Function Documentation

virtual const char* vtkExecutive::GetClassName  )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

int vtkExecutive::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 vtkObject.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

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

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

vtkExecutive* vtkExecutive::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

void vtkExecutive::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 vtkObject.

Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

virtual int vtkExecutive::Update vtkAlgorithm algorithm  )  [pure virtual]
 

Bring the given algorithm's outputs up-to-date. The algorithm must already be managed by this executive. Returns 1 for success and 0 for failure.

Implemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

virtual int vtkExecutive::Update vtkAlgorithm algorithm,
int  port
[pure virtual]
 

Bring the given algorithm's output on the given port up-to-date. The algorithm must already be managed by this executive. Returns 1 for success and 0 for failure.

Implemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, vtkDistributedExecutive, and vtkStreamingDemandDrivenPipeline.

virtual vtkInformation* vtkExecutive::GetOutputInformation vtkAlgorithm algorithm,
int  port
[pure virtual]
 

Get the information object for an output port of an algorithm.

Implemented in vtkDemandDrivenPipeline, and vtkDistributedExecutive.

virtual vtkDataObject* vtkExecutive::GetOutputData vtkAlgorithm algorithm,
int  port
[pure virtual]
 

Get/Set the data object for an output port of an algorithm.

Implemented in vtkDemandDrivenPipeline, and vtkDistributedExecutive.

virtual void vtkExecutive::SetOutputData vtkAlgorithm algorithm,
int  port,
vtkDataObject
[pure virtual]
 

Get/Set the data object for an output port of an algorithm.

Implemented in vtkDemandDrivenPipeline, and vtkDistributedExecutive.

virtual vtkAlgorithmOutput* vtkExecutive::GetProducerPort vtkDataObject  )  [pure virtual]
 

Get the output port that produces the given data object.

Implemented in vtkDistributedExecutive.

virtual vtkDataObject* vtkExecutive::GetInputData vtkAlgorithm algorithm,
int  port,
int  connection
[pure virtual]
 

Get the data object for an output port of an algorithm.

Implemented in vtkDemandDrivenPipeline, and vtkDistributedExecutive.

virtual void vtkExecutive::UnRegister vtkObjectBase o  )  [virtual]
 

Decrement the count of references to this object and participate in garbage collection.

Reimplemented from vtkObject.

vtkInformationExecutiveKey* vtkExecutive::EXECUTIVE  )  [static]
 

vtkInformationIntegerKey* vtkExecutive::PORT_NUMBER  )  [static]
 

virtual void vtkExecutive::AddAlgorithm vtkAlgorithm algorithm  )  [protected, pure virtual]
 

Add/Remove a algorithm from the control of this executive. Some executives support more than one algorithm while others do not. These methods are called by vtkAlgorithm::SetExecutive and should not be called from elsewhere.

Implemented in vtkDistributedExecutive.

virtual void vtkExecutive::RemoveAlgorithm vtkAlgorithm algorithm  )  [protected, pure virtual]
 

Add/Remove a algorithm from the control of this executive. Some executives support more than one algorithm while others do not. These methods are called by vtkAlgorithm::SetExecutive and should not be called from elsewhere.

Implemented in vtkDistributedExecutive.

virtual void vtkExecutive::GarbageCollectionStarting  )  [protected, virtual]
 

Reimplemented from vtkObjectBase.


Member Data Documentation

int vtkExecutive::GarbageCollecting [protected]
 

Definition at line 110 of file vtkExecutive.h.


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