HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
PDG_ApplicationShim::DeferredTask Class Referenceabstract

#include <PDG_ApplicationShim.h>

+ Inheritance diagram for PDG_ApplicationShim::DeferredTask:

Public Member Functions

 DeferredTask (PDG_GraphContext *context, const PDG_Node *node, const PDG_WorkItem *work_item, PDG_EvaluationContext::State state)
 
virtual ~DeferredTask ()
 
void execute ()
 Evaluates the task. More...
 
bool wait ()
 

Protected Member Functions

virtual void evaluate ()=0
 Called when the task is evaluated. More...
 

Protected Attributes

PDG_GraphContextmyContext
 
const PDG_NodemyNode
 
const PDG_WorkItemmyWorkItem
 
PDG_EvaluationContext::State myState
 
int myCookId
 
bool myHasExecuted
 

Detailed Description

Base class for a task that can be queued. Should be subclassed to implement a concrete task type that stores data and logic.

Definition at line 152 of file PDG_ApplicationShim.h.

Constructor & Destructor Documentation

PDG_ApplicationShim::DeferredTask::DeferredTask ( PDG_GraphContext context,
const PDG_Node node,
const PDG_WorkItem work_item,
PDG_EvaluationContext::State  state 
)
virtual PDG_ApplicationShim::DeferredTask::~DeferredTask ( )
inlinevirtual

Definition at line 160 of file PDG_ApplicationShim.h.

Member Function Documentation

virtual void PDG_ApplicationShim::DeferredTask::evaluate ( )
protectedpure virtual

Called when the task is evaluated.

void PDG_ApplicationShim::DeferredTask::execute ( )

Evaluates the task.

bool PDG_ApplicationShim::DeferredTask::wait ( )

Waits for the task to execute. Returns true if the task completed, or false if it was interupted for some reason.

Member Data Documentation

PDG_GraphContext* PDG_ApplicationShim::DeferredTask::myContext
protected

Definition at line 174 of file PDG_ApplicationShim.h.

int PDG_ApplicationShim::DeferredTask::myCookId
protected

Definition at line 180 of file PDG_ApplicationShim.h.

bool PDG_ApplicationShim::DeferredTask::myHasExecuted
protected

Definition at line 181 of file PDG_ApplicationShim.h.

const PDG_Node* PDG_ApplicationShim::DeferredTask::myNode
protected

Definition at line 175 of file PDG_ApplicationShim.h.

PDG_EvaluationContext::State PDG_ApplicationShim::DeferredTask::myState
protected

Definition at line 179 of file PDG_ApplicationShim.h.

const PDG_WorkItem* PDG_ApplicationShim::DeferredTask::myWorkItem
protected

Definition at line 176 of file PDG_ApplicationShim.h.


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