vtkComputingResources Class Reference

Definition of computing resource (threads/kernels) More...

#include <vtkComputingResources.h>

Inheritance diagram for vtkComputingResources:

Collaboration diagram for vtkComputingResources:

List of all members.

Public Types
typedef vtkObject	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	Clear ()
void	ObtainMinimumResources ()
void	ObtainMaximumResources ()
void	Deploy (vtkThreadedStreamingPipeline *exec, vtkInformation *info)
bool	Reserve (vtkComputingResources *res)
void	Collect (vtkComputingResources *res)
vtkProcessingUnitResource *	GetResourceFor (int processingUnit)
Static Public Member Functions
static vtkComputingResources *	New ()
static int	IsTypeOf (const char *type)
static vtkComputingResources *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkComputingResources ()
	~vtkComputingResources ()
Protected Attributes
implementation *const	Implementation

---

Detailed Description

Definition of computing resource (threads/kernels)

This is a class for distribute the number of threads to a network of modules

See also:

vtkExecutionScheduler

Definition at line 49 of file vtkComputingResources.h.

---

Member Typedef Documentation

typedef vtkObject vtkComputingResources::Superclass

Reimplemented from vtkObject.

Definition at line 53 of file vtkComputingResources.h.

---

Constructor & Destructor Documentation

vtkComputingResources::vtkComputingResources

(

)

[protected]

vtkComputingResources::~vtkComputingResources

(

)

[protected]

---

Member Function Documentation

static vtkComputingResources* vtkComputingResources::New

(

)

[static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkObject.

virtual const char* vtkComputingResources::GetClassName

(

)

[virtual]

Reimplemented from vtkObject.

static int vtkComputingResources::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 vtkComputingResources::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 vtkComputingResources* vtkComputingResources::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkObject.

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

void vtkComputingResources::Clear

(

)

Set resources to an empty states

void vtkComputingResources::ObtainMinimumResources

(

)

Assign a minimum amount of usable resources to this object, e.g. 1 thread

void vtkComputingResources::ObtainMaximumResources

(

)

Assign a maximum amount of usable resources to this object

vtkProcessingUnitResource* vtkComputingResources::GetResourceFor

(

int

processingUnit

)

Return the resources of a specific type of processing unit that is hold in this object

void vtkComputingResources::Deploy	(	vtkThreadedStreamingPipeline *	exec,
		vtkInformation *	info
	)

Assign the resources and information of this object to an executive, i.e., set the number of threads of the algorithm the executive is pointing to

bool vtkComputingResources::Reserve

(

vtkComputingResources *

res

)

Take an amount of computing resources out of this object. Return true if it is successful.

void vtkComputingResources::Collect

(

vtkComputingResources *

res

)

Add an amount of computing resources to this object

---

Member Data Documentation

implementation* const vtkComputingResources::Implementation [protected]

Definition at line 91 of file vtkComputingResources.h.

---

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

• dox/Filtering/vtkComputingResources.h