vtkDistributedExecutive Class Reference

#include <vtkDistributedExecutive.h>

Inheritance diagram for vtkDistributedExecutive:

[legend]Collaboration diagram for vtkDistributedExecutive:

[legend]List of all members.

Detailed Description

Superclass for distributed executives.

vtkDistributedExecutive is the superclass for VTK's distributed executives. Some pipeline architectures are more easily maintained with an executive instance per algorithm (vtkAlgorithm instance). This class references algorithms in a distributed manner so subclasses can focus on their pipeline update designs.

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (79%)
Martin, Ken (20%)

CVS logs (CVSweb):

.h (/Filtering/vtkDistributedExecutive.h)
.cxx (/Filtering/vtkDistributedExecutive.cxx)

Definition at line 41 of file vtkDistributedExecutive.h.

Public Types

typedef vtkExecutive Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

vtkAlgorithm * GetAlgorithm ()

virtual vtkAlgorithmOutput * GetProducerPort (vtkDataObject *)

virtual int Update ()

virtual int Update (int port)

virtual int Update (vtkAlgorithm *algorithm)

virtual int Update (vtkAlgorithm *algorithm, int port)

virtual vtkInformation * GetOutputInformation (int port)

virtual vtkInformation * GetOutputInformation (vtkAlgorithm *algorithm, int port)

virtual vtkDataObject * GetOutputData (int port)

virtual vtkDataObject * GetOutputData (vtkAlgorithm *algorithm, int port)

virtual void SetOutputData (int port, vtkDataObject *)

virtual void SetOutputData (vtkAlgorithm *algorithm, int port, vtkDataObject *)

virtual vtkDataObject * GetInputData (vtkAlgorithm *algorithm, int port, int connection)

virtual vtkDataObject * GetInputData (int port, int connection)

Static Public Member Functions

vtkDistributedExecutive * New ()

int IsTypeOf (const char *type)

vtkDistributedExecutive * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkDistributedExecutive ()

~vtkDistributedExecutive ()

int InputPortIndexInRange (int port, const char *action)

int OutputPortIndexInRange (int port, const char *action)

virtual void AddAlgorithm (vtkAlgorithm *algorithm)

virtual void RemoveAlgorithm (vtkAlgorithm *algorithm)

virtual void ReportReferences (vtkGarbageCollector *)

virtual void RemoveReferences ()

virtual void SetAlgorithm (vtkAlgorithm *algorithm)

Protected Attributes

vtkAlgorithm * Algorithm

Member Typedef Documentation

typedef vtkExecutive vtkDistributedExecutive::Superclass

Reimplemented from vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.
Definition at line 45 of file vtkDistributedExecutive.h.

Constructor & Destructor Documentation

vtkDistributedExecutive::vtkDistributedExecutive ( ) [protected]

vtkDistributedExecutive::~vtkDistributedExecutive ( ) [protected]

Member Function Documentation

vtkDistributedExecutive* vtkDistributedExecutive::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

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

Reimplemented from vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

int vtkDistributedExecutive::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 vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

virtual int vtkDistributedExecutive::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 vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

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

Reimplemented from vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

void vtkDistributedExecutive::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 vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

vtkAlgorithm* vtkDistributedExecutive::GetAlgorithm ( )

Distributed executives have a one-to-one correspondence with their algorithms. Get the algorithm to which this executive has been assigned.

virtual int vtkDistributedExecutive::Update ( ) [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.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

virtual int vtkDistributedExecutive::Update ( int port ) [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.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

virtual int vtkDistributedExecutive::Update ( vtkAlgorithm * algorithm ) [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.
Implements vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

virtual int vtkDistributedExecutive::Update ( vtkAlgorithm * algorithm,

int port

) [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.
Implements vtkExecutive.
Reimplemented in vtkCachedStreamingDemandDrivenPipeline, vtkDemandDrivenPipeline, and vtkStreamingDemandDrivenPipeline.

virtual vtkInformation* vtkDistributedExecutive::GetOutputInformation ( int port ) [virtual]

Get the information object for an output port of an algorithm.
Reimplemented in vtkDemandDrivenPipeline.

virtual vtkInformation* vtkDistributedExecutive::GetOutputInformation ( vtkAlgorithm * algorithm,

int port

) [virtual]

Get the information object for an output port of an algorithm.
Implements vtkExecutive.
Reimplemented in vtkDemandDrivenPipeline.

virtual vtkDataObject* vtkDistributedExecutive::GetOutputData ( int port ) [virtual]

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

virtual vtkDataObject* vtkDistributedExecutive::GetOutputData ( vtkAlgorithm * algorithm,

int port

) [virtual]

Get/Set the data object for an output port of an algorithm.
Implements vtkExecutive.
Reimplemented in vtkDemandDrivenPipeline.

virtual void vtkDistributedExecutive::SetOutputData ( int port,

vtkDataObject *

) [virtual]

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

virtual void vtkDistributedExecutive::SetOutputData ( vtkAlgorithm * algorithm,

int port,

vtkDataObject *

) [virtual]

Get/Set the data object for an output port of an algorithm.
Implements vtkExecutive.
Reimplemented in vtkDemandDrivenPipeline.

virtual vtkDataObject* vtkDistributedExecutive::GetInputData ( vtkAlgorithm * algorithm,

int port,

int connection

) [virtual]

Get the data object for an output port of an algorithm.
Implements vtkExecutive.
Reimplemented in vtkDemandDrivenPipeline.

virtual vtkDataObject* vtkDistributedExecutive::GetInputData ( int port,

int connection

) [virtual]

Get the data object for an output port of an algorithm.
Reimplemented in vtkDemandDrivenPipeline.

virtual vtkAlgorithmOutput* vtkDistributedExecutive::GetProducerPort ( vtkDataObject * ) [virtual]

Get the output port that produces the given data object.
Implements vtkExecutive.

int vtkDistributedExecutive::InputPortIndexInRange ( int port,

const char * action

) [protected]

int vtkDistributedExecutive::OutputPortIndexInRange ( int port,

const char * action

) [protected]

virtual void vtkDistributedExecutive::AddAlgorithm ( vtkAlgorithm * algorithm ) [protected, 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.
Implements vtkExecutive.

virtual void vtkDistributedExecutive::RemoveAlgorithm ( vtkAlgorithm * algorithm ) [protected, 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.
Implements vtkExecutive.

virtual void vtkDistributedExecutive::ReportReferences ( vtkGarbageCollector * ) [protected, virtual]

Reimplemented from vtkObjectBase.
Reimplemented in vtkDemandDrivenPipeline.

virtual void vtkDistributedExecutive::RemoveReferences ( ) [protected, virtual]

Reimplemented from vtkObjectBase.
Reimplemented in vtkDemandDrivenPipeline.

virtual void vtkDistributedExecutive::SetAlgorithm ( vtkAlgorithm * algorithm ) [protected, virtual]

Member Data Documentation

vtkAlgorithm* vtkDistributedExecutive::Algorithm [protected]

Definition at line 106 of file vtkDistributedExecutive.h.

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

dox/Filtering/vtkDistributedExecutive.h


Public Types
typedef vtkExecutive	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
vtkAlgorithm *	GetAlgorithm ()
virtual vtkAlgorithmOutput *	GetProducerPort (vtkDataObject *)

virtual int	Update ()
virtual int	Update (int port)
virtual int	Update (vtkAlgorithm *algorithm)
virtual int	Update (vtkAlgorithm *algorithm, int port)

virtual vtkInformation *	GetOutputInformation (int port)
virtual vtkInformation *	GetOutputInformation (vtkAlgorithm *algorithm, int port)

virtual vtkDataObject *	GetOutputData (int port)
virtual vtkDataObject *	GetOutputData (vtkAlgorithm *algorithm, int port)
virtual void	SetOutputData (int port, vtkDataObject *)
virtual void	SetOutputData (vtkAlgorithm algorithm, int port, vtkDataObject )

virtual vtkDataObject *	GetInputData (vtkAlgorithm *algorithm, int port, int connection)
virtual vtkDataObject *	GetInputData (int port, int connection)
Static Public Member Functions
vtkDistributedExecutive *	New ()
int	IsTypeOf (const char *type)
vtkDistributedExecutive *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkDistributedExecutive ()
	~vtkDistributedExecutive ()
int	InputPortIndexInRange (int port, const char *action)
int	OutputPortIndexInRange (int port, const char *action)
virtual void	AddAlgorithm (vtkAlgorithm *algorithm)
virtual void	RemoveAlgorithm (vtkAlgorithm *algorithm)
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	RemoveReferences ()
virtual void	SetAlgorithm (vtkAlgorithm *algorithm)
Protected Attributes
vtkAlgorithm *	Algorithm