VTK
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>

Inheritance diagram for vtkComputingResources:
[legend]
Collaboration diagram for vtkComputingResources:
[legend]

Public Types

typedef vtkObject Superclass
 
- Public Types inherited from vtkObject
typedef vtkObjectBase 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)
 
vtkProcessingUnitResourceGetResourceFor (int processingUnit)
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkComputingResourcesNew ()
 
static int IsTypeOf (const char *type)
 
static vtkComputingResourcesSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkComputingResources ()
 
 ~vtkComputingResources ()
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

implementation *const Implementation
 
- Protected Attributes inherited from vtkObject
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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

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
virtual const char* vtkComputingResources::GetClassName ( )
virtual

Reimplemented from vtkObject.

static int vtkComputingResources::IsTypeOf ( const char *  type)
static
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
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: