vtkProcess Class Reference

a process that can be launched by a vtkMultiProcessController More...

#include <vtkProcess.h>

Inheritance diagram for vtkProcess:

Collaboration diagram for vtkProcess:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkProcess *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	Execute ()=0
vtkMultiProcessController *	GetController ()
void	SetController (vtkMultiProcessController *aController)
int	GetReturnValue ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkProcess *	SafeDownCast (vtkObjectBase *o)
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkProcess ()
Protected Attributes
vtkMultiProcessController *	Controller
int	ReturnValue

---

Detailed Description

a process that can be launched by a vtkMultiProcessController

vtkProcess is an abstract class representing a process that can be launched by a vtkMultiProcessController. Concrete classes just have to implement Execute() method and make sure it set the proper value in ReturnValue.

Example:

class MyProcess: public vtkProcess ... vtkMultiProcessController *c; MyProcess *p=new MyProcess::New(); p->SetArgs(argc,argv); // some parameters specific to the process p->SetX(10.0); // ... c->SetSingleProcess(p); c->SingleMethodExecute(); int returnValue=p->GetReturnValue();

See also:

vtkMultiProcessController

Tests:

vtkProcess (Tests)

Definition at line 48 of file vtkProcess.h.

---

Member Typedef Documentation

typedef vtkObject vtkProcess::Superclass

Reimplemented from vtkObject.

Definition at line 51 of file vtkProcess.h.

---

Constructor & Destructor Documentation

vtkProcess::vtkProcess

(

)

[protected]

---

Member Function Documentation

static int vtkProcess::IsTypeOf

(

const char *

name

)

[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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

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

static vtkProcess* vtkProcess::SafeDownCast

(

vtkObjectBase *

o

)

[static]

Reimplemented from vtkObject.

virtual vtkObjectBase* vtkProcess::NewInstanceInternal

(

)

const [protected, virtual]

Reimplemented from vtkObject.

vtkProcess* vtkProcess::NewInstance

(

)

const

Reimplemented from vtkObject.

void vtkProcess::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.

virtual void vtkProcess::Execute

(

)

[pure virtual]

Entry point of the process. This method is expected to update ReturnValue.

vtkMultiProcessController* vtkProcess::GetController

(

)

Give access to the controller that launched the process. Initial value is NULL.

void vtkProcess::SetController

(

vtkMultiProcessController *

aController

)

This method should not be called directly but set by the controller itself.

int vtkProcess::GetReturnValue

(

)

Value set at the end of a call to Execute.

---

Member Data Documentation

vtkMultiProcessController* vtkProcess::Controller [protected]

Definition at line 72 of file vtkProcess.h.

int vtkProcess::ReturnValue [protected]

Definition at line 73 of file vtkProcess.h.

---

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

• dox/Parallel/Core/vtkProcess.h