vtkExecutionScheduler Class Reference

#include <vtkExecutionScheduler.h>

Inheritance diagram for vtkExecutionScheduler:

Inheritance graph
[legend]
Collaboration diagram for vtkExecutionScheduler:

Collaboration graph
[legend]

List of all members.


Detailed Description

Scheduling execution with thread/computing resources distributing.

This is a class for balancing the computing resources throughout the network

See also:
vtkComputingResources vtkThreadedStreamingPipeline
Events:
vtkCommand::UpdateEvent
Tests:
vtkExecutionScheduler (Tests)

Definition at line 61 of file vtkExecutionScheduler.h.


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 Schedule (vtkExecutiveCollection *execs, vtkInformation *info)
void SchedulePropagate (vtkExecutiveCollection *execs, vtkInformation *info)
void WaitUntilDone (vtkExecutiveCollection *execs)
void WaitUntilReleased (vtkExecutiveCollection *execs)
void WaitUntilAllDone ()
void WaitForTaskDone (vtkExecutive *exec)
void WaitForInputsReleased (vtkExecutive *exec)
vtkThreadMessagerGetTaskDoneMessager (vtkExecutive *exec)
vtkThreadMessagerGetInputsReleasedMessager (vtkExecutive *exec)
vtkMutexLockGetInputsReleasedLock (vtkExecutive *exec)
void ReleaseResources (vtkExecutive *exec)
void ReacquireResources (vtkExecutive *exec)
void RescheduleNetwork (vtkExecutive *sink)
void RescheduleFrom (vtkExecutive *sink, vtkComputingResources *resources)

Static Public Member Functions

static vtkExecutionSchedulerNew ()
static int IsTypeOf (const char *type)
static vtkExecutionSchedulerSafeDownCast (vtkObject *o)
static vtkExecutionSchedulerGetGlobalScheduler ()
static vtkInformationIntegerKeyTASK_PRIORITY ()

Protected Member Functions

 vtkExecutionScheduler ()
 ~vtkExecutionScheduler ()

Protected Attributes

vtkComputingResourcesResources
vtkThreadMessagerScheduleMessager
vtkThreadMessagerResourceMessager
vtkMutexLockScheduleLock
vtkMultiThreaderScheduleThreader
int ScheduleThreadId
implementation *const Implementation

Friends

class implementation
void * vtkExecutionScheduler_ScheduleThread (void *data)
void * vtkExecutionScheduler_ExecuteThread (void *data)

Member Typedef Documentation

Reimplemented from vtkObject.

Definition at line 65 of file vtkExecutionScheduler.h.


Constructor & Destructor Documentation

vtkExecutionScheduler::vtkExecutionScheduler (  )  [protected]

vtkExecutionScheduler::~vtkExecutionScheduler (  )  [protected]


Member Function Documentation

static vtkExecutionScheduler* vtkExecutionScheduler::New (  )  [static]

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

Reimplemented from vtkObject.

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

Reimplemented from vtkObject.

static int vtkExecutionScheduler::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 vtkExecutionScheduler::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 vtkExecutionScheduler* vtkExecutionScheduler::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkObject.

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

static vtkExecutionScheduler* vtkExecutionScheduler::GetGlobalScheduler (  )  [static]

Return the global instance of the scheduler

static vtkInformationIntegerKey* vtkExecutionScheduler::TASK_PRIORITY (  )  [static]

Key to store the priority of a task

void vtkExecutionScheduler::Schedule ( vtkExecutiveCollection execs,
vtkInformation info 
)

Put the current set of executives (modules) to the be scheduled given its dependency graph which will be used to compute the set topological orders

void vtkExecutionScheduler::SchedulePropagate ( vtkExecutiveCollection execs,
vtkInformation info 
)

Put the current set of executives (modules) to the be scheduled given its dependency graph which will be used to compute the set topological orders. Then wait for their execution to be complete

void vtkExecutionScheduler::WaitUntilDone ( vtkExecutiveCollection execs  ) 

Wait until the current set of executives (modules) have finished executing

void vtkExecutionScheduler::WaitUntilReleased ( vtkExecutiveCollection execs  ) 

Wait until the current set of executives (modules) have their inputs released

void vtkExecutionScheduler::WaitUntilAllDone (  ) 

Wait for all tasks to be done

void vtkExecutionScheduler::WaitForTaskDone ( vtkExecutive exec  ) 

Wait for a task that is on the scheduling queue to be done. If the task is not there, this will return immediately. If the exec is NULL, any task that is done will trigger this the return

void vtkExecutionScheduler::WaitForInputsReleased ( vtkExecutive exec  ) 

Similar to WaitForTaskDone but return whenever input connections of a task are released instead of done computing. But exec cannot be NULL.

vtkThreadMessager* vtkExecutionScheduler::GetTaskDoneMessager ( vtkExecutive exec  ) 

Return the thread messager reserved for the given exec to notify when it is done

vtkThreadMessager* vtkExecutionScheduler::GetInputsReleasedMessager ( vtkExecutive exec  ) 

Return the thread messager reserved for the given exec to notify when it releases its inputs

vtkMutexLock* vtkExecutionScheduler::GetInputsReleasedLock ( vtkExecutive exec  ) 

Return the mutex lock reserved for the given exec to notify when it releases its inputs

void vtkExecutionScheduler::ReleaseResources ( vtkExecutive exec  ) 

Release the resources that are being used by the given exec

void vtkExecutionScheduler::ReacquireResources ( vtkExecutive exec  ) 

Re-acquire the resource released earlier by ReleaseResource

void vtkExecutionScheduler::RescheduleNetwork ( vtkExecutive sink  ) 

Redistribute the thread resources over the network from a sink with a maximum resource

void vtkExecutionScheduler::RescheduleFrom ( vtkExecutive sink,
vtkComputingResources resources 
)

Redistribute the thread resources from a sink given a certain amount of resource


Friends And Related Function Documentation

friend class implementation [friend]

Definition at line 144 of file vtkExecutionScheduler.h.

void* vtkExecutionScheduler_ScheduleThread ( void *  data  )  [friend]

The scheduling thread that is responsible for queueing up module execution in the right order

void* vtkExecutionScheduler_ExecuteThread ( void *  data  )  [friend]

Execute thread function that is responsible for forking process for each module


Member Data Documentation

Definition at line 134 of file vtkExecutionScheduler.h.

Definition at line 135 of file vtkExecutionScheduler.h.

Definition at line 136 of file vtkExecutionScheduler.h.

Definition at line 137 of file vtkExecutionScheduler.h.

Definition at line 138 of file vtkExecutionScheduler.h.

Definition at line 139 of file vtkExecutionScheduler.h.

implementation* const vtkExecutionScheduler::Implementation [protected]

Definition at line 142 of file vtkExecutionScheduler.h.


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

Generated on Mon Sep 27 18:22:56 2010 for VTK by  doxygen 1.5.6