VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkComputingResources Class Reference

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

#include <vtkComputingResources.h>

Inherits vtkObject.

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkComputingResourcesNewInstance () const
 
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)
 
vtkProcessingUnitResourceGetResourceFor (int processingUnit)
 

Static Public Member Functions

static vtkComputingResourcesNew ()
 
static int IsTypeOf (const char *type)
 
static vtkComputingResourcesSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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 50 of file vtkComputingResources.h.

Member Typedef Documentation

Definition at line 54 of file vtkComputingResources.h.

Constructor & Destructor Documentation

vtkComputingResources::vtkComputingResources ( )
protected
vtkComputingResources::~vtkComputingResources ( )
protected

Member Function Documentation

static vtkComputingResources* vtkComputingResources::New ( )
static
static int vtkComputingResources::IsTypeOf ( const char *  type)
static
virtual int vtkComputingResources::IsA ( const char *  type)
virtual
static vtkComputingResources* vtkComputingResources::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkComputingResources::NewInstanceInternal ( ) const
protectedvirtual
vtkComputingResources* vtkComputingResources::NewInstance ( ) const
void vtkComputingResources::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 92 of file vtkComputingResources.h.


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