UT_TaskScope Class Reference

#include <UT_TaskScope.h>

Inheritance diagram for UT_TaskScope:

UT_SmallObject< UT_TaskScope > UT_SmallObjectDefaultSuperClass

List of all members.

Public Member Functions

 UT_TaskScope (const UT_TaskScope *parent, int thread)
 UT_TaskScope (const UT_TaskScope *parent)
 ~UT_TaskScope ()
const UT_TaskScopegetParent () const
 Return the parent of this task scope.
bool isAncestor (const UT_TaskScope &parent) const
 Test if the given task scope is an ancestor of ours.

Static Public Member Functions

static const UT_TaskScopegetCurrent (int thread)
static const UT_TaskScopegetCurrent ()
static const UT_TaskScopegetOrCreateCurrent (int thread)
static const UT_TaskScopegetOrCreateCurrent ()


Detailed Description

Scope object which defines a thread task, maintaining a parent-child hierarchy.

Definition at line 49 of file UT_TaskScope.h.


Constructor & Destructor Documentation

UT_TaskScope::UT_TaskScope ( const UT_TaskScope parent,
int  thread 
) [inline, explicit]

Definition at line 52 of file UT_TaskScope.h.

UT_TaskScope::UT_TaskScope ( const UT_TaskScope parent  )  [inline, explicit]

Definition at line 60 of file UT_TaskScope.h.

UT_TaskScope::~UT_TaskScope (  )  [inline]

Definition at line 69 of file UT_TaskScope.h.


Member Function Documentation

static const UT_TaskScope* UT_TaskScope::getCurrent ( void   )  [inline, static]

Obtain the current task scope from thread local storage.

Note:
The return value is NULL if there is no current task scope.

Definition at line 85 of file UT_TaskScope.h.

static const UT_TaskScope* UT_TaskScope::getCurrent ( int  thread  )  [inline, static]

Obtain the current task scope from thread local storage.

Note:
The return value is NULL if there is no current task scope.

Definition at line 81 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateCurrent (  )  [inline, static]

Obtain the current task scope from thread local storage, creating one if there is none.

Definition at line 102 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateCurrent ( int  thread  )  [inline, static]

Obtain the current task scope from thread local storage, creating one if there is none.

Definition at line 94 of file UT_TaskScope.h.

const UT_TaskScope* UT_TaskScope::getParent (  )  const [inline]

Return the parent of this task scope.

Definition at line 76 of file UT_TaskScope.h.

bool UT_TaskScope::isAncestor ( const UT_TaskScope parent  )  const [inline]

Test if the given task scope is an ancestor of ours.

Definition at line 109 of file UT_TaskScope.h.


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

Generated on Mon Jan 28 00:30:21 2013 for HDK by  doxygen 1.5.9