HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
UT_TaskScope Class Reference

#include <UT_TaskScope.h>

+ Inheritance diagram for UT_TaskScope:

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. More...
 
int getThreadId () const
 Return the id of the assigned thread. More...
 
bool isAncestor (const UT_TaskScope &parent) const
 Test if the given task scope is an ancestor of ours. More...
 

Static Public Member Functions

static const UT_TaskScopegetCurrent (int thread)
 
static const UT_TaskScopegetCurrent ()
 
static const UT_TaskScopegetOrCreateCurrent (int thread)
 
static const UT_TaskScopegetOrCreateCurrent ()
 
static const UT_TaskScopegetOrCreateRoot (int thread)
 
static const UT_TaskScopegetOrCreateRoot ()
 
- Static Public Member Functions inherited from UT_SmallObject< UT_TaskScope >
static voidoperator new (size_t size)
 Regular new/delete operators. More...
 
static void operator delete (void *p, size_t size)
 Regular new/delete operators. More...
 
static voidoperator new (size_t, void *p)
 
static void operator delete (void *, void *)
 

Detailed Description

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

Definition at line 42 of file UT_TaskScope.h.

Constructor & Destructor Documentation

UT_TaskScope::UT_TaskScope ( const UT_TaskScope parent,
int  thread 
)
inlineexplicit

Definition at line 45 of file UT_TaskScope.h.

UT_TaskScope::UT_TaskScope ( const UT_TaskScope parent)
inlineexplicit

Definition at line 60 of file UT_TaskScope.h.

UT_TaskScope::~UT_TaskScope ( )
inline

Definition at line 75 of file UT_TaskScope.h.

Member Function Documentation

static const UT_TaskScope* UT_TaskScope::getCurrent ( int  thread)
inlinestatic

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 94 of file UT_TaskScope.h.

static const UT_TaskScope* UT_TaskScope::getCurrent ( void  )
inlinestatic

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 98 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateCurrent ( int  thread)
inlinestatic

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

Definition at line 107 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateCurrent ( )
inlinestatic

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

Definition at line 115 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateRoot ( int  thread)
inlinestatic

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

Definition at line 124 of file UT_TaskScope.h.

static const UT_TaskScope& UT_TaskScope::getOrCreateRoot ( )
inlinestatic

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

Definition at line 137 of file UT_TaskScope.h.

const UT_TaskScope* UT_TaskScope::getParent ( ) const
inline

Return the parent of this task scope.

Definition at line 86 of file UT_TaskScope.h.

int UT_TaskScope::getThreadId ( ) const
inline

Return the id of the assigned thread.

Definition at line 89 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 144 of file UT_TaskScope.h.


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